WP_REST_Server::get_index( array $request ): WP_REST_Response

Retrieves the site index.


Description

This endpoint describes the capabilities of the site.


Top ↑

Parameters

$request array Required
Request.
  • contextstring
    Context.

Top ↑

Return

WP_REST_Response The API root index data.


Top ↑

Source

File: wp-includes/rest-api/class-wp-rest-server.php. View all references

public function get_index( $request ) {
	// General site data.
	$available = array(
		'name'            => get_option( 'blogname' ),
		'description'     => get_option( 'blogdescription' ),
		'url'             => get_option( 'siteurl' ),
		'home'            => home_url(),
		'gmt_offset'      => get_option( 'gmt_offset' ),
		'timezone_string' => get_option( 'timezone_string' ),
		'namespaces'      => array_keys( $this->namespaces ),
		'authentication'  => array(),
		'routes'          => $this->get_data_for_routes( $this->get_routes(), $request['context'] ),
	);

	$response = new WP_REST_Response( $available );
	$response->add_link( 'help', 'https://developer.wordpress.org/rest-api/' );
	$this->add_active_theme_link_to_index( $response );
	$this->add_site_logo_to_index( $response );
	$this->add_site_icon_to_index( $response );

	/**
	 * Filters the REST API root index data.
	 *
	 * 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.
	 *
	 * @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 );
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
4.4.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.