rest_prepare_(post_type) │ filter-hook │ WP 4.7.0

Filters the post data for a REST API response.

The dynamic portion of the hook name, $this->post_type, refers to the post type slug.

Possible hook names include:

• rest_prepare_post
• rest_prepare_page
• rest_prepare_attachment

Usage

add_filter( 'rest_prepare_(post_type)', 'wp_kama_rest_prepare_post_type_filter', 10, 3 );

/**
 * Function for `rest_prepare_(post_type)` 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_post_type_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

Where the hook is called

return apply_filters( "rest_prepare_{$this->post_type}", $response, $post, $request );

return apply_filters( "rest_prepare_{$this->post_type}", new WP_REST_Response( array() ), $post, $request );

Where the hook is used in WordPress

add_filter( 'rest_prepare_page', 'insert_hooked_blocks_into_rest_response', 10, 2 );

add_filter( 'rest_prepare_post', 'insert_hooked_blocks_into_rest_response', 10, 2 );

add_filter( 'rest_prepare_wp_block', 'insert_hooked_blocks_into_rest_response', 10, 2 );

add_filter( 'rest_prepare_wp_navigation', 'insert_hooked_blocks_into_rest_response', 10, 2 );