apply_filters( 'rest_prepare_status', WP_REST_Response $response, object $status, WP_REST_Request $request )
- Since
- 4.7.0
Filters a post status returned from the REST API.
Description
Allows modification of the status data right before it is returned.
Compatibility
- WordPress
- since 4.7.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
$responseWP_REST_Response- The response object.
$statusobject- The original post status object.
$requestWP_REST_Request- Request used to generate the response.
Where this hook fires · 1
wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php:285WP_REST_Post_Statuses_Controller::prepare_item_for_response()
Source code
* @since 4.7.0 * * @param WP_REST_Response $response The response object. * @param object $status The original post status object. * @param WP_REST_Request $request Request used to generate the response. */ return apply_filters( 'rest_prepare_status', $response, $status, $request ); } /** * Retrieves the post status' schema, conforming to JSON Schema. * * @since 4.7.0Changelog
Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 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.