rest_endpoints_description
Filters the REST endpoint data.
Description
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.
- $data = apply_filters( 'rest_endpoints_description', $data );
- if ( !empty( $data ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the rest_endpoints_description callback
- function filter_rest_endpoints_description( $data ) {
- // make filter magic happen here...
- return $data;
- };
- // add the filter
- add_filter( 'rest_endpoints_description', 'filter_rest_endpoints_description', 10, 1 );
- To remove a hook callback, use the example below.
- // remove the filter
- 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
- $available[ $route ] = apply_filters( 'rest_endpoints_description', $data );