Создание пользовательских конечных точек для WordPress REST API

 'args' => [ 'category_id' => array( 'sanitize_callback' => function($value, $request, $param) { if($value < 6){ return 6; }; }) ], 

Если идентификатор категории меньше шести, мы просто возвращаем шесть. Таким образом, мы гарантируем, что получим событие допустимого значения только в том случае, если клиент передает значение, не поддерживаемое API. Этот пример немного искусственный, так как на самом деле у нас нет необходимости ограничивать идентификатор категории, чтобы он был больше или равен шести, а просто ради демонстрации двух функций обратного вызова.

Обратный вызов проверки будет иметь приоритет над обратным вызовом очистки. В нашем примере, если вы используете оба обратных вызова и отправляете недопустимое значение ( <6 ) для идентификатора категории, вы получите Invalid parameter (s): category_id error, который не даст sanitize_callback() шанс быть уволенным и дезинфицировать данные.

Обратите внимание, что вам может не потребоваться добавлять какие-либо проверки или дезинфекции, потому что может быть достаточно шаблона регулярных выражений, который вы используете в маршруте. Например, в нашем случае ?P<category_id>\d+ определяет URL, который принимает только положительные числа. Любой другой ввод выдаст ошибку «Обработчик маршрута недействителен» .

Ограничение доступа к конечным точкам

Вы можете ограничить доступ к конечным точкам, используя функцию permission_callback() , которая проверяет, есть ли у пользователя необходимые разрешения на выполнение действия до вызова обратного вызова основного обработчика. Это позволяет вам сообщить клиенту, какие действия он может выполнить с определенным URL-адресом, не пытаясь сначала выполнить запрос.

Функция permission_callback() должна возвращать значение true или false или экземпляр класса WP_Error .

Вам просто нужно передать permission_callback в функцию register_rest_route() , которая позволяет вам добавлять разрешения, управляющие доступом к конечной точке. Например:

 add_action('rest_api_init', function () { register_rest_route( 'mytwentyseventeentheme/v1', 'latest-posts/(?P<category_id>\d+)',array( 'methods' => 'GET', 'callback' => 'get_latest_posts_by_category', 'permission_callback' => function() { return current_user_can('edit_posts'); } )); }); 

Обратный вызов current_user_can() вызывает функцию current_user_can() чтобы проверить, аутентифицирован ли пользователь и обладает ли он необходимой возможностью ( edit_posts ) для выполнения действия. Так что, если клиент не аутентифицирован , будет сгенерирована ошибка.

Если у вас нет прав, вы получите ошибку rest_forbidden :

Мы также можем просто вернуть true из permission_callback чтобы разрешить доступ всем без какой-либо аутентификации.

Использование шаблона контроллера

Для работы со сложными конечными точками рекомендуется использовать шаблон контроллера вместо определения пользовательских маршрутов, как мы видели в предыдущем примере.

Шаблон контроллера просто включает расширение встроенного класса WP_REST_Controller , который реализует базовую функциональность, необходимую для обработки HTTP-запросов, и позволяет вам воспользоваться надежным кодом с лучшими практиками, используемыми встроенными конечными точками WP-API.

 class Latest_Posts_Controller extends WP_REST_Controller {} 

 class Latest_Posts_Controller extends WP_REST_Controller { public function register_routes() { $namespace = 'mytwentyseventeentheme/v1'; $path = 'latest-posts/(?P<category_id>\d+)'; register_rest_route( $namespace, '/' . $path, [ array( 'methods' => 'GET', 'callback' => array( $this, 'get_items' ), 'permission_callback' => array( $this, 'get_items_permissions_check' ) ), ]); } } 

  public function get_items_permissions_check($request) { return true; } 

  public function get_items($request) { $args = array( 'category' => $request['category_id'] ); $posts = get_posts($args); if (empty($posts)) { return new WP_Error( 'empty_category', 'there is no post in this category', array( 'status' => 404 ) ); } return new WP_REST_Response($posts, 200); } 

 add_action('rest_api_init', function () { $latest_posts_controller = new Latest_Posts_Controller(); $latest_posts_controller->register_routes(); }