rest_prepare_status

Filters a status returned from the REST API.

Description

apply_filters( 'rest_prepare_status', (WP_REST_Response) $response, (object) $status, (WP_REST_Request) $request ); 

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

Parameters (3)

0. $response (WP_REST_Response)
The response object.
1. $status (object)
The original status object.
2. $request (WP_REST_Request)
Request used to generate the response.

Usage

To run the hook, copy the example below.
  1. $response = apply_filters( 'rest_prepare_status', $response, $status, $request ); 
  2.  
  3. if ( !empty( $response ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the rest_prepare_status callback 
  2. function filter_rest_prepare_status( $response, $status, $request ) { 
  3. // make filter magic happen here... 
  4. return $response
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'rest_prepare_status', 'filter_rest_prepare_status', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'rest_prepare_status', 'filter_rest_prepare_status', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php  
  1. return apply_filters( 'rest_prepare_status', $response, $status, $request );