rest_post_dispatch

Filters the API response.

Description

apply_filters( 'rest_post_dispatch', (WP_HTTP_Response) $rest_ensure_response, (WP_REST_Server) $instance, (WP_REST_Request) $request ); 

Allows modification of the response before returning.

Parameters (3)

0. $rest_ensure_response (WP_HTTP_Response) => rest_ensure_response( $result )
Result to send to the client. Usually a WP_REST_Response.
1. $instance (WP_REST_Server)
Server instance.
2. $request (WP_REST_Request)
Request used to generate the response.

Usage

To run the hook, copy the example below.
  1. $rest_ensure_response = apply_filters( 'rest_post_dispatch', $rest_ensure_response, $instance, $request ); 
  2.  
  3. if ( !empty( $rest_ensure_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_post_dispatch callback 
  2. function filter_rest_post_dispatch( $rest_ensure_response, $instance, $request ) { 
  3. // make filter magic happen here... 
  4. return $rest_ensure_response
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'rest_post_dispatch', 'filter_rest_post_dispatch', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'rest_post_dispatch', 'filter_rest_post_dispatch', 10, 3 ); 

Defined (3)

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

/wp-includes/rest-api/class-wp-rest-server.php  
  1. $result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $request ); 
  1. $response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $this, $request ); 
/wp-includes/rest-api.php  
  1. add_filter( 'rest_post_dispatch', 'rest_send_allow_header', 10, 3 );