rest_pre_serve_request WordPress Filter Hook
The rest_pre_serve_request hook allows you to modify the data that is returned by the REST API before it is served to the client. This can be useful for adding extra data to the response or for filtering the data that is returned.
apply_filters( 'rest_pre_serve_request', bool $served , WP_HTTP_Response $result , WP_REST_Request $request , WP_REST_Server $server ) #
Filters whether the REST API request has already been served.
Description
Allow sending the request manually – by returning true, the API result will not be sent to the client.
Parameters
- $served
(bool)Whether the request has already been served. Default false.
- $result
(WP_HTTP_Response)Result to send to the client. Usually a
WP_REST_Response
.- $request
(WP_REST_Request)Request used to generate the response.
- $server
(WP_REST_Server)Server instance.
Source
Changelog
Version | Description |
---|---|
4.4.0 | Introduced. |