{"id":92871,"date":"2023-10-31T12:41:00","date_gmt":"2023-10-31T12:41:00","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=92871"},"modified":"2024-07-26T13:20:38","modified_gmt":"2024-07-26T13:20:38","slug":"add-custom-rest-api-route-wordpress","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/add-custom-rest-api-route-wordpress\/","title":{"rendered":"How to Add Custom REST API Route in WordPress?"},"content":{"rendered":"\n

WordPress provides us with the ability to create Custom WordPress REST API<\/a> Route and endpoints.<\/p>\n\n\n\n

You can use the Rewrites API, as well as the query classes: WP_Query, WP_User, etc) for creating your URL mappings, or custom queries.<\/p>\n\n\n\n

This blog describes – how we can add custom REST API routes in WordPress. The use of API is very common nowadays. <\/p>\n\n\n\n

So, when we work with API we need some custom routes along with default ones so that we can facilitate intended tasks.<\/p>\n\n\n\n

When we add our custom routes, we must not affect the default ones. We should add new routes with default ones, not in place of default routes. <\/p>\n\n\n\n

Registering a Custom Rest Route<\/h2>\n\n\n\n

We can register a custom Rest API route through the function register_rest_route<\/code>. <\/p>\n\n\n\n

The  register_rest_route<\/code> function takes three arguments: the namespace, the route we want, and the options. <\/p>\n\n\n\n

This function is added as a callback function to action rest_api_init. Let webkul\/v1<\/code> be our namespace. <\/p>\n\n\n\n

We will explain this in detail in the namespaces later in the blog. Our registered route will match anything \/webkulposts\/{id}<\/code>, where {id}<\/code> is an integer.<\/p>\n\n\n\n

Example-<\/h3>\n\n\n\n

We use the rest_api_init hook which fires when preparing to serve an API request.<\/p>\n\n\n\n

add_action( 'rest_api_init', 'wk_register_custom_routes' );\n<\/pre>\n\n\n\n
Now, we register our route in the callback function of the above action using the function register_rest_route –<\/p>\n\n\n\n
function wk_register_custom_routes() {\n\tregister_rest_route(\n\t\t'webkul\/v1',\n\t\t'\/webkulposts\/{id}',\n\t\tarray(\n\t\t\tarray(\n\t\t\t\t'methods'  => 'GET',\n\t\t\t\t'callback' => 'wk_get_post_callback',\n\t\t\t),\n\t\t\tarray(\n\t\t\t\t'methods'  => 'PUT',\n\t\t\t\t'callback' => 'wk_put_post_callback',\n\t\t\t),\n\t\t\tarray(\n\t\t\t\t'methods'  => 'DELETE,\n\t\t\t\t'callback' => 'wk_delete_post_callback',\n\t\t\t),\n\t\t)\n\t);\n}\n\npublic funcion wk_put_post_callback($request)\n{\n  \/\/ Your code \n}\n\npublic funcion wk_delete_post_callback($request )\n{\n  \/\/ Your code \n}<\/pre>\n\n\n\n
Here we have registered the three endpoints for the route. <\/p>\n\n\n\n
The  \u201croute\u201d refers to the URL, whereas the \u201cendpoint\u201d refers to the function behind it that corresponds to a method.<\/p>\n\n\n\n
Endpoints are nothing but the functions that can be accessed via the APIs. Endpoints take some number of parameters and return the requested data.<\/p>\n\n\n\n
The URL \u201cname\u201d you use to access endpoints, is called a route. A route can have multiple endpoints associated with it, which is used depending on the HTTP verb.<\/p>\n\n\n\n
For example, with the URL `http:\/\/webkul.com\/wp-json\/webkul\/v1<\/code>\/webkulposts<\/code>\/23`:<\/p>\n\n\n\n