W3cubDocs

/WordPress

WP_REST_Server::get_namespace_index( WP_REST_Request $request )

Retrieves the index for a namespace.

Parameters

$request

(WP_REST_Request) (Required) REST request instance.

Return

(WP_REST_Response|WP_Error) WP_REST_Response instance if the index was found, WP_Error if the namespace isn't set.

Source

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

public function get_namespace_index( $request ) {
		$namespace = $request['namespace'];

		if ( ! isset( $this->namespaces[ $namespace ] ) ) {
			return new WP_Error(
				'rest_invalid_namespace',
				__( 'The specified namespace could not be found.' ),
				array( 'status' => 404 )
			);
		}

		$routes    = $this->namespaces[ $namespace ];
		$endpoints = array_intersect_key( $this->get_routes(), $routes );

		$data     = array(
			'namespace' => $namespace,
			'routes'    => $this->get_data_for_routes( $endpoints, $request['context'] ),
		);
		$response = rest_ensure_response( $data );

		// Link to the root index.
		$response->add_link( 'up', rest_url( '/' ) );

		/**
		 * Filters the namespace index data.
		 *
		 * This typically is just the route data for the namespace, but you can
		 * add any data you'd like here.
		 *
		 * @since 4.4.0
		 *
		 * @param WP_REST_Response $response Response data.
		 * @param WP_REST_Request  $request  Request data. The namespace is passed as the 'namespace' parameter.
		 */
		return apply_filters( 'rest_namespace_index', $response, $request );
	}

Uses

Uses Description
wp-includes/rest-api.php: rest_ensure_response()

Ensures a REST response is a response object (for consistency).
wp-includes/rest-api.php: rest_url()

Retrieves the URL to a REST endpoint.
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_namespace_index

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

Retrieves the route map.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.

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_namespace_index