rest_pre_dispatch WordPress Filter Hook
The rest_pre_dispatch hook is triggered before a request is dispatched to a REST API endpoint. This hook can be used to modify the request before it is processed by the endpoint.
apply_filters( 'rest_pre_dispatch', mixed $result , WP_REST_Server $server , WP_REST_Request $request ) #
Filters the pre-calculated result of a REST API dispatch request.
Description
Allow hijacking the request before dispatching by returning a non-empty. The returned value will be used to serve the request instead.
Parameters
- $result
(mixed)Response to replace the requested version with. Can be anything a normal endpoint can return, or null to not hijack the request.
- $server
(WP_REST_Server)Server instance.
- $request
(WP_REST_Request)Request used to generate the response.
Source
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |