PHP code example of gebruederheitz / wp-simple-rest
1. Go to this page and download the library: Download gebruederheitz/wp-simple-rest library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
gebruederheitz / wp-simple-rest example snippets
use Gebruederheitz\Traits\withREST;
/* optional */
use Gebruederheitz\Wordpress\Rest\RestRoute;
class MyClass {
// use the trait
use withREST;
public function __construct() {
// initialize the REST functionality
$this->initInstanceRestApi();
}
// Callbacks for your routes must be public
public function myRestCallback() {}
// Define your Routes by implementing the abstract method
public function getInstanceRestRoutes()
{
return [
// Using the RestRoute helper object
RestRoute::create(
'A description of what your route does.',
'/rest-example'
)
->setCallback([$this, 'myRestCallback'])
->setMethods('POST')
->allowAnyone()
->addArgument(
'parameter_one',
'A description of what the argument is for.',
'a default value',
'string',
[$this, 'sanitizeParameterOne'],
[$this, 'validateParameterOne']
)
->addArgument(
'other_param',
'A parameter that is essential to this route.',
)
,
// Using the legacy array format
[
'name' => 'A description of what your route does',
'route' => '/rest-example',
'config' => [
'methods' => 'POST',
'callback' => [$this, 'myRestCallback'],
'permission_callback' => function () {
return current_user_can('edit_posts');
},
'args' => [
'parameter_one' => [
'description' => 'A description of what the argument is for',
'default' => '',
'type' => 'string',
'sanitize_callback' => 'esc_url_raw',
]
]
]
],
// Restricting access
RestRoute::create(
'Do dangerous things with the database',
'/danger-zone/database',
)
->setCallback([$this, 'restDangerousDbOperation'])
// only users with 'install_plugins' capabilities
->allowOnlyAdmins()
// or only users with 'edit_posts' capabilities
->allowOnlyEditors()
// or a custom callback allowing you to check for capabilities
// ...with a closure
->setPermissionCallback(function() {
return current_user_can('read_private_pages');
})
// ...with a class method
->setPermissionCallback([$this, 'canUserAccessDbDangerZone'])
// ...with a static class method
->setPermissionCallback([self::class, 'canUserAccessStatic'])
,
];
}
// Must have an implementation, in this case it's just a dummy
protected static function getRestRoutes(): array
{
return [];
}
}
use Gebruederheitz\Traits\withREST;
class MyClass {
// use the trait
use withREST;
public static function init() {
// initialize the REST functionality
self::initRestApi();
}
public static function myRestCallback() {}
// This is the dummy this time around
public function getInstanceRestRoutes()
{
return [];
}
// Define your Routes by implementing the abstract method
protected static function getRestRoutes(): array
{
return [
[
'name' => 'A description of what your route does',
'route' => '/rest-example',
'config' => [
'methods' => 'POST',
'callback' => [self::class, 'myRestCallback'],
'permission_callback' => function () {
return current_user_can('edit_posts');
},
'args' => [
'parameter_one' => [
'description' => 'A description of what the argument is for',
'default' => '',
'type' => 'string',
'sanitize_callback' => 'esc_url_raw',
]
]
]
],
];
}
}
RestRoute::create('Name', '/path')
// public route
->allowAnyone()
// or only users with 'install_plugins' capabilities
->allowOnlyAdmins()
// or only users with 'edit_posts' capabilities
->allowOnlyEditors()
// or a custom callback allowing you to check for capabilities
// ...with a closure
->setPermissionCallback(function() {
return current_user_can('read_private_pages');
})
// ...with a class method
->setPermissionCallback([$this, 'canUserAccessDbDangerZone'])
// ...with a static class method
->setPermissionCallback([self::class, 'canUserAccessStatic'])
// list only the static routes
MyClass::getRestEndpoints();
// Both static and instance routes
$myClassInstance->getAllRestEndpoints();
class MyClass {
use \Gebruederheitz\Traits\withREST;
public static $restNamespaceBase = 'my-rest-routes';
}
/* BEFORE */
use Gebruederheitz\Traits\Rest\withREST
/* AFTER */
use Gebruederheitz\Wordpress\Rest\Traits\withREST
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.