rest_request_before_callbacks

Filters the response before executing any REST API callbacks.

Description

apply_filters( 'rest_request_before_callbacks', (WP_HTTP_Response) $response, (WP_REST_Server) $handler, (WP_REST_Request) $request ); 

Allows plugins to perform additional validation after a request is initialized and matched to a registered route, but before it is executed.

Note that this filter will not be called for requests that fail to authenticate or match to a registered route.

Parameters (3)

0. $response (WP_HTTP_Response)
Result to send to the client. Usually a WP_REST_Response.
1. $handler (WP_REST_Server)
ResponseHandler instance (usually WP_REST_Server).
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_request_before_callbacks', $response, $handler, $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_request_before_callbacks callback 
  2. function filter_rest_request_before_callbacks( $response, $handler, $request ) { 
  3. // make filter magic happen here... 
  4. return $response
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'rest_request_before_callbacks', 'filter_rest_request_before_callbacks', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'rest_request_before_callbacks', 'filter_rest_request_before_callbacks', 10, 3 ); 

Defined (1)

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

/wp-includes/rest-api/class-wp-rest-server.php  
  1. $response = apply_filters( 'rest_request_before_callbacks', $response, $handler, $request );