WP_REST_Server::match_request_to_handler( WP_REST_Request $request ): array|WP_Error
- Since
- 5.6.0
- Source
wp-includes/rest-api/class-wp-rest-server.php:1153
Compatibility
- WordPress
- since 5.6.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$requestWP_REST_Request- The request object.
Return value
array|WP_Error- The route and request handler on success or a WP_Error instance if no handler was found.
Performance profile
How much work a call to WP_REST_Server::match_request_to_handler() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Light
- Scaling
- Scales with input
- Instructions
- 27–72
- Plugin surface
- None
- Called by
- 3
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 120.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Server::match_request_to_handler() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 27–29 | ->get_method(), ->get_route(), ->get_namespaces(), ->get_routes(), __() |
| always | 30–32 | ->get_method(), ->get_route(), ->get_namespaces(), array_merge(), __() |
!$routes && preg_match() && !$handlers && !empty($checked_method) && !is_callable() | 49–55 | ->get_method(), ->get_route(), ->get_namespaces(), ->get_routes(), preg_match(), is_callable() |
!$routes && preg_match() && !$handlers && !empty($checked_method) && !is_callable() | 52–58 | ->get_method(), ->get_route(), ->get_namespaces(), array_merge(), preg_match(), is_callable() |
!$routes && preg_match() && !$handlers && !empty($checked_method) && is_callable() | 62–69 | ->get_method(), ->get_route(), ->get_namespaces(), ->get_routes(), preg_match(), is_callable(), ->set_url_params(), ->set_attributes(), ->set_default_params() |
!$routes && preg_match() && !$handlers && !empty($checked_method) && is_callable() | 65–72 | ->get_method(), ->get_route(), ->get_namespaces(), array_merge(), preg_match(), is_callable(), ->set_url_params(), ->set_attributes(), ->set_default_params() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 120 | 27–72 | 19 | |
| 8.5 | 120 | 27–72 | 19 | |
| 8.4 | 120 | 27–72 | 19 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 123 | 27–72 | 19 | |
| 8.2 | 123 | 27–72 | 19 | |
| 8.1 | 123 | 27–72 | 19 | 1 more instruction than PHP 7.4 |
| 7.4 | 122 | 27–71 | 19 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 6
- str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
- trailingslashit()Appends a trailing slash.
- __()Retrieves the translation of $text.
- WP_REST_Server::get_namespaces()Retrieves namespaces registered on the server.
- WP_REST_Server::get_routes()Retrieves the route map.
- WP_Error::__construct()Initializes the error.
Used by · 3
- WP_REST_Server::dispatch()Matches the request to a callback and call it.
- WP_REST_Server::embed_links()Embeds the links from the data into the request.
- WP_REST_Server::serve_batch_request_v1()Serves the batch/v1 request.
Source code
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 ( str_starts_with( 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']; // 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 ) ); }Changelog
Introduced in 5.6.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/rest-api/class-wp-rest-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.