rest_index

Filters the API root index data.

Description

apply_filters( 'rest_index', (WP_REST_Response) $response ); 

This contains the data describing the API. This includes information about supported authentication schemes, supported namespaces, routes available on the API, and a small amount of data about the site.

Parameters (1)

0. $response (WP_REST_Response)
Response data.

Usage

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

Defined (1)

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

/wp-includes/rest-api/class-wp-rest-server.php  
  1. return apply_filters( 'rest_index', $response );