rest_handle_options_request() – Function

Handles OPTIONS requests for the server.

Description

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

Parameters

$responsemixedrequired: Current response, either response or null to indicate pass-through.
$handlerWP_REST_Serverrequired: ResponseHandler instance (usually WP_REST_Server).
$requestWP_REST_Requestrequired: The request that was used to make current response.

Return

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

Source

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 ) {
			$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 all references View on Trac View on GitHub

Changelog

Version	Description
4.4.0	Introduced.

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

In this article

Description

Parameters

Return

Source

Changelog

User Contributed Notes