W3cubDocs

/WordPress

apply_filters( ‘rest_index’, WP_REST_Response $response, WP_REST_Request $request )

Filters the REST API root index data.

Description

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

$responseWP_REST_Response
Response data.
$requestWP_REST_Request
Request data.

Source

return apply_filters( 'rest_index', $response, $request );

Changelog

Version Description
6.0.0 Added $request parameter.
4.4.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/rest_index