rest_prepare_status │ filter-hook │ WP 4.7.0

Filters a post status returned from the REST API.

Allows modification of the status data right before it is returned.

Usage

add_filter( 'rest_prepare_status', 'wp_kama_rest_prepare_status_filter', 10, 3 );

/**
 * Function for `rest_prepare_status` filter-hook.
 * 
 * @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 WP_REST_Response
 */
function wp_kama_rest_prepare_status_filter( $response, $status, $request ){

	// filter...
	return $response;
}

$response(WP_REST_Response)

The response object.

$status(object)

The original post status object.

$request(WP_REST_Request)

Request used to generate the response.

Changelog

Where the hook is called

return apply_filters( 'rest_prepare_status', $response, $status, $request );

Where the hook is used in WordPress