rest_endpoints

Filters the array of available endpoints.

Description

apply_filters( 'rest_endpoints', (array) $this_endpoints ); 

Parameters (1)

0. $this_endpoints (array)
The available endpoints. An array of matching regex patterns, each mapped to an array of callbacks for the endpoint. These take the format ''/path/regex' => array( $callback, $bitmask )' or ''/path/regex' => array( array( $callback, $bitmask ).

Usage

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

Defined (1)

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

/wp-includes/rest-api/class-wp-rest-server.php  
  1. $endpoints = apply_filters( 'rest_endpoints', $this->endpoints );