wppaste
WordPress

apply_filters( 'rest_index', WP_REST_Response $response, WP_REST_Request $request )

Since
4.4.0, 6.0.0
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.

Compatibility

WordPress
since 6.0.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$responseWP_REST_Response
Response data.
$requestWP_REST_Request
Request data.

Where this hook fires · 1

  • wp-includes/rest-api/class-wp-rest-server.php:1416WP_REST_Server::get_index()

Source code

View on Trac View on GitHub 

		 * @since 4.4.0		 * @since 6.0.0 Added `$request` parameter.		 *		 * @param WP_REST_Response $response Response data.		 * @param WP_REST_Request  $request  Request data.		 */		return apply_filters( 'rest_index', $response, $request );	} 	/**	 * Adds a link to the active theme for users who have proper permissions.	 *	 * @since 5.7.0

Changelog

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

6.0.0
Added $request parameter.from the docblock
4.4.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.