On this page
WP_REST_Server::match_request_to_handler( WP_REST_Request $request ): array|WP_Error
This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.
Matches a request object to its handler.
Parameters
$requestWP_REST_Request Required-
The request object.
Return
array|WP_Error The route and request handler on success or a WP_Error instance if no handler was found.
Source
File: wp-includes/rest-api/class-wp-rest-server.php. View all references
protected function match_request_to_handler( $request ) {
$method = $request->get_method();
$path = $request->get_route();
$with_namespace = array();
foreach ( $this->get_namespaces() as $namespace ) {
if ( 0 === strpos( trailingslashit( ltrim( $path, '/' ) ), $namespace ) ) {
$with_namespace[] = $this->get_routes( $namespace );
}
}
if ( $with_namespace ) {
$routes = array_merge( ...$with_namespace );
} else {
$routes = $this->get_routes();
}
foreach ( $routes as $route => $handlers ) {
$match = preg_match( '@^' . $route . '$@i', $path, $matches );
if ( ! $match ) {
continue;
}
$args = array();
foreach ( $matches as $param => $value ) {
if ( ! is_int( $param ) ) {
$args[ $param ] = $value;
}
}
foreach ( $handlers as $handler ) {
$callback = $handler['callback'];
$response = null;
// Fallback to GET method if no HEAD method is registered.
$checked_method = $method;
if ( 'HEAD' === $method && empty( $handler['methods']['HEAD'] ) ) {
$checked_method = 'GET';
}
if ( empty( $handler['methods'][ $checked_method ] ) ) {
continue;
}
if ( ! is_callable( $callback ) ) {
return array( $route, $handler );
}
$request->set_url_params( $args );
$request->set_attributes( $handler );
$defaults = array();
foreach ( $handler['args'] as $arg => $options ) {
if ( isset( $options['default'] ) ) {
$defaults[ $arg ] = $options['default'];
}
}
$request->set_default_params( $defaults );
return array( $route, $handler );
}
}
return new WP_Error(
'rest_no_route',
__( 'No route was found matching the URL and request method.' ),
array( 'status' => 404 )
);
}
Related
Uses
| Uses | Description |
|---|---|
| WP_REST_Server::get_namespaces() wp-includes/rest-api/class-wp-rest-server.php | Retrieves namespaces registered on the server. |
| WP_REST_Server::get_routes() wp-includes/rest-api/class-wp-rest-server.php | Retrieves the route map. |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| trailingslashit() wp-includes/formatting.php | Appends a trailing slash. |
| WP_Error::__construct() wp-includes/class-wp-error.php | Initializes the error. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Server::serve_batch_request_v1() wp-includes/rest-api/class-wp-rest-server.php | Serves the batch/v1 request. |
| WP_REST_Server::dispatch() wp-includes/rest-api/class-wp-rest-server.php | Matches the request to a callback and call it. |
Changelog
| Version | Description |
|---|---|
| 5.6.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_server/match_request_to_handler