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

Handles OPTIONS requests for the server.

Description

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

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.

Return

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

Source

File: wp-includes/rest-api.php 

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() );

		if ( ! $match ) {
			continue;
		}

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

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

Expand Source Code View on GitHub

Changelog

Changelog
Version Description
WP-4.4.0 Introduced.