Custom endpoint registration in Wordpress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a custom endpoint in WordPress REST API?

A custom endpoint is a new URL path added to the WordPress REST API that allows you to create your own API routes to handle specific data or actions beyond the default WordPress endpoints.

beginner

Which WordPress function is used to register a custom REST API endpoint?

The function register_rest_route() is used to add a custom endpoint to the WordPress REST API.

intermediate

What are the main parameters of register_rest_route()?

The main parameters are:

• namespace: a string to group your routes (e.g., 'myplugin/v1')
• route: the endpoint path (e.g., '/data')
• args: an array defining HTTP methods, callback functions, permissions, and arguments

intermediate

How do you ensure only authorized users can access your custom endpoint?

You add a permission_callback function in the endpoint args that returns true if the user has permission, or false otherwise. For example, checking if the user is logged in or has a specific capability.

beginner

Where should you hook your custom endpoint registration code in WordPress?

You should hook it to the rest_api_init action. This ensures your endpoint is registered when the REST API initializes.

Which hook is used to register custom REST API endpoints in WordPress?

A wp_loaded

B init

C admin_init

D rest_api_init

The rest_api_init hook is specifically designed for registering REST API routes.

What does the register_rest_route() function NOT require?

A Namespace

B Route path

C Database connection

D Callback function

You do not need to provide a database connection when registering a REST route.

How do you restrict access to a custom endpoint to logged-in users only?

A Set <code>methods</code> to POST only

B Use <code>permission_callback</code> to check if user is logged in

C Add a nonce field in the URL

D Use <code>register_post_type</code>

The permission_callback lets you control who can access the endpoint.

What HTTP methods can you specify in register_rest_route()?

A GET, POST, PUT, DELETE, PATCH

B Only GET

C Only POST

D Only PUT and DELETE

You can specify any HTTP method supported by the REST API.

What is the purpose of the 'namespace' parameter in register_rest_route()?

A To group related endpoints under a common path

B To define the database table

C To set user permissions

D To specify the HTTP method

Namespace helps organize endpoints logically, like 'myplugin/v1'.

Explain how to create a custom REST API endpoint in WordPress from start to finish.

Think about the steps to add a new URL path that returns data securely.

Describe how permission callbacks work in custom endpoint registration and why they are important.

Consider how you keep your API safe from unwanted users.