W3cubDocs

/WordPress

WP_REST_Server::get_index( array $request )

Retrieves the site index.

Description

This endpoint describes the capabilities of the site.

Parameters

$request

(array) (Required) Request.

  • 'context'
    (string) Context.

Return

(WP_REST_Response) The API root index data.

Source

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

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', 'http://v2.wp-api.org/' );

		/**
		 * Filters the 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
		 *
		 * @param WP_REST_Response $response Response data.
		 */
		return apply_filters( 'rest_index', $response );
	}

Uses

Uses Description
wp-includes/rest-api/class-wp-rest-server.php: WP_REST_Server::get_data_for_routes()

Retrieves the publicly-visible data for routes.
wp-includes/rest-api/class-wp-rest-server.php: rest_index

Filters the API root index data.
wp-includes/rest-api/class-wp-rest-server.php: WP_REST_Server::get_routes()

Retrieves the route map.
wp-includes/link-template.php: home_url()

Retrieves the URL for the current site where the front end is accessible.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.

Changelog

Version Description
4.4.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_server/get_index