rest_endpoints_description

Filters the REST endpoint data.

Description

apply_filters( 'rest_endpoints_description', (WP_REST_Request) $data ); 

Parameters (1)

0. $data (WP_REST_Request)
Request data. The namespace is passed as the namespace parameter.

Usage

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

Defined (1)

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

/wp-includes/rest-api/class-wp-rest-server.php  
  1. $available[ $route ] = apply_filters( 'rest_endpoints_description', $data );