钩子文档

rest_dispatch_request

💡 云策文档标注

概述

rest_dispatch_request 是一个 WordPress REST API 过滤器,允许插件覆盖请求的调度结果。它主要用于在请求被分发到回调处理程序之前进行干预。

关键要点

  • 这是一个过滤器钩子,用于修改 REST API 请求的调度结果。
  • 参数包括 $dispatch_result(调度结果)、$request(WP_REST_Request 对象)、$route(匹配的路由)和 $handler(路由处理程序)。
  • 在 WP_REST_Server::respond_to_request() 方法中使用,影响请求的分发过程。
  • 从 WordPress 4.4.0 版本引入,4.5.0 版本增加了 $route 和 $handler 参数。

代码示例

$dispatch_result = apply_filters( 'rest_dispatch_request', null, $request, $route, $handler );

📄 原文内容

Filters the REST API dispatch request result.

Description

Allow plugins to override dispatching the request.

Parameters

$dispatch_resultmixed
Dispatch result, will be used if not empty.
$requestWP_REST_Request
Request used to generate the response.
$routestring
Route matched for the request.
$handlerarray
Route handler used for the request.

Source

$dispatch_result = apply_filters( 'rest_dispatch_request', null, $request, $route, $handler );

Changelog

Version Description
4.5.0 Added $route and $handler parameters.
4.4.0 Introduced.