WP_REST_Server::get_data_for_routes( array $routes, string $context = 'view' )
Retrieves the publicly-visible data for routes.
Parameters
- $routes
-
(Required) Routes to get data for.
- $context
-
(Optional) Context for data. Accepts 'view' or 'help'. Default 'view'.
Default value: 'view'
Return
(array) Route data to expose in indexes.
Source
File: wp-includes/rest-api/class-wp-rest-server.php
public function get_data_for_routes( $routes, $context = 'view' ) {
$available = array();
// Find the available routes.
foreach ( $routes as $route => $callbacks ) {
$data = $this->get_data_for_route( $route, $callbacks, $context );
if ( empty( $data ) ) {
continue;
}
/**
* Filters the REST endpoint data.
*
* @since WP-4.4.0
*
* @param WP_REST_Request $request Request data. The namespace is passed as the 'namespace' parameter.
*/
$available[ $route ] = apply_filters( 'rest_endpoints_description', $data );
}
/**
* Filters the publicly-visible data for routes.
*
* This data is exposed on indexes and can be used by clients or
* developers to investigate the site and find out how to use it. It
* acts as a form of self-documentation.
*
* @since WP-4.4.0
*
* @param array $available Map of route to route data.
* @param array $routes Internal route data as an associative array.
*/
return apply_filters( 'rest_route_data', $available, $routes );
}
Changelog
Version | Description |
---|---|
WP-4.4.0 | Introduced. |