rest_prepare_page
Filters the post data for a REST API response.
This is one of the variants of the dynamic hook rest_prepare_(post_type)
Usage
add_filter( 'rest_prepare_page', 'wp_kama_rest_prepare_page_filter', 10, 3 );
/**
* Function for `rest_prepare_page` filter-hook.
*
* @param WP_REST_Response $response The response object.
* @param WP_Post $post Post object.
* @param WP_REST_Request $request Request object.
*
* @return WP_REST_Response
*/
function wp_kama_rest_prepare_page_filter( $response, $post, $request ){
// filter...
return $response;
}
- $response(WP_REST_Response)
- The response object.
- $post(WP_Post)
- Post object.
- $request(WP_REST_Request)
- Request object.
Changelog
| Since 4.7.0 | Introduced. |
Where the hook is called
rest_prepare_page
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2142
return apply_filters( "rest_prepare_{$this->post_type}", $response, $post, $request );
Where the hook is used in WordPress
wp-includes/default-filters.php 786
add_filter( 'rest_prepare_page', 'insert_hooked_blocks_into_rest_response', 10, 2 );