media-store-net / wp-rest-registration
A Simple Way to Register Rest Routes to WP
Requires
- php: >=7.3 || >=8.0
Requires (Dev)
- brain/monkey: ^2.0
- inpsyde/monkery-test-case: ^5.0
- inpsyde/php-coding-standards: ^0.13
- phpunit/phpunit: ^8.3
README
A Simple Way to Register Rest Routes to WordPress
Installation
The easiest way to install is using Composer in your Project
composer require media-store-net/wp-rest-registration:dev-master
Download the Repo on Github
https://github.com/media-store-net/WpRestRegistration
or clone it
git clone https://github.com/media-store-net/WpRestRegistration.git
How to use?
First you need define a Callback function in your functions.php or other File that is included in your Wordpres Installation or anyone of your Plugin Files.
Define Callback Function
-
For GET Request
function myFunction(WP_REST_Request $request) { // return anything as REST Logic } -
for POST Request
function myPostFunction(WP_REST_Request $request) { // Do anything with $request // return response }
Use WpRestRegistration Class
now you can register a Route calling the WpRestRegistartion Class
on Top of your php-file
use MediaStoreNet\WpRestRegistration\WpRestRegistration as Rest
register a Route
new Rest( $Namespace, $RestName, $Callback, $Method = GET, $permission_callback='__return_true' $actionHook = 'rest_api_init' )
- basic usage for GET Request
new Rest( 'myApp/v1', 'myRestName', 'myFunction' );
By default you can omit the optional parameters for a GET Endpoint To call the RestRoute use https://myPage.com/wp-json/myApp/v1/myRestName in your Browser or using Postman
- basic usage for POST Request
new Rest( 'myApp/v1', 'myRestName', 'myPostFunction', 'POST' );
Now you can call the same URL, using POST-Method and include $data to your Request
- edit permissions
By default is the $permissions_callback='__return_true' open for all requests.
But you can change this bahaviouer for your endpoints
new Rest( 'myApp/v1', 'myRestName', 'myFunction', 'GET', current_user_can('manage_options') )