rest_handle_options_request( mixed $response, WP_REST_Server $handler, WP_REST_Request $request ): WP_REST_Response

Handles OPTIONS requests for the server.

Description
Parameters
Return
Source
Changelog
User Contributed Notes

Description

This is handled outside of the server code, as it doesn’t obey normal route mapping.

Top ↑

Parameters

$response mixed Required: Current response, either response or null to indicate pass-through.
$handler WP_REST_Server Required: ResponseHandler instance (usually WP_REST_Server).
$request WP_REST_Request Required: The request that was used to make current response.

Top ↑

Return

WP_REST_Response Modified response, either response or null to indicate pass-through.

Top ↑

Source

File: wp-includes/rest-api.php. View all references

function rest_handle_options_request( $response, $handler, $request ) {
	if ( ! empty( $response ) || $request->get_method() !== 'OPTIONS' ) {
		return $response;
	}

	$response = new WP_REST_Response();
	$data     = array();

	foreach ( $handler->get_routes() as $route => $endpoints ) {
		$match = preg_match( '@^' . $route . '$@i', $request->get_route(), $matches );

		if ( ! $match ) {
			continue;
		}

		$args = array();
		foreach ( $matches as $param => $value ) {
			if ( ! is_int( $param ) ) {
				$args[ $param ] = $value;
			}
		}

		foreach ( $endpoints as $endpoint ) {
			// Remove the redundant preg_match() argument.
			unset( $args[0] );

			$request->set_url_params( $args );
			$request->set_attributes( $endpoint );
		}

		$data = $handler->get_data_for_route( $route, $endpoints, 'help' );
		$response->set_matched_route( $route );
		break;
	}

	$response->set_data( $data );
	return $response;
}

View on Trac View on GitHub

Top ↑