rest_pre_dispatch filter-hook . WP 4.4.0

Filters the pre-calculated result of a REST dispatch request.

Allow hijacking the request before dispatching by returning a non-empty. The returned value will be used to serve the request instead.

Usage

add_filter( 'rest_pre_dispatch', 'filter_function_name_3021', 10, 3 );
function filter_function_name_3021( $result, $this, $request ){
	// filter...

	return $result;
}

$result(mixed)

Response to replace the requested version with. Can be anything a normal endpoint can return, or null to not hijack the request.

$this(WP_REST_Server)

Server instance.

$request(WP_REST_Request)

Request used to generate the response.

Changelog

Where the hook is called

$result = apply_filters( 'rest_pre_dispatch', null, $this, $request );

Where the hook is used (in WP core)

add_filter( 'rest_pre_dispatch', 'rest_handle_options_request', 10, 3 );