apply_filters( 'rest_post_dispatch', WP_HTTP_Response $result, WP_REST_Server $server, WP_REST_Request $request )
- Since
- 4.4.0, 4.5.0
Filters the REST API response.
Description
Allows modification of the response before returning.
Compatibility
- WordPress
- since 4.5.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Parameters
$resultWP_HTTP_Response- Result to send to the client. Usually a
WP_REST_Response. $serverWP_REST_Server- Server instance.
$requestWP_REST_Request- Request used to generate the response.
Where this hook fires · 4
wp-includes/rest-api.php:3033rest_preload_api_request()wp-includes/rest-api/class-wp-rest-server.php:464WP_REST_Server::serve_request()wp-includes/rest-api/class-wp-rest-server.php:824WP_REST_Server::embed_links()wp-includes/rest-api/class-wp-rest-server.php:1894WP_REST_Server::serve_batch_request_v1()
Changelog
Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
4.5.0
Applied to embedded responses.from the docblock
4.4.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
- Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.