rest_namespace_index

Filters the namespace index data.

Description

apply_filters( 'rest_namespace_index', (WP_REST_Response) $response, (WP_REST_Request) $request ); 

This typically is just the route data for the namespace, but you can add any data you'd like here.

Parameters (2)

0. $response (WP_REST_Response)
Response data.
1. $request (WP_REST_Request)
Request data. The namespace is passed as the namespace parameter.

Usage

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

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_namespace_index', $response, $request );