Alert: 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.

WP_REST_Server::match_request_to_handler( WP_REST_Request $request ): array|WP_Error

Matches a request object to its handler.


Parameters

$request WP_REST_Request Required
The request object.

Top ↑

Return

array|WP_Error The route and request handler on success or a WP_Error instance if no handler was found.


Top ↑

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 ( 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'];
			$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 )
	);
}


Top ↑

Changelog

Changelog
Version Description
5.6.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.