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_765', 10, 3 ); function filter_function_name_765( $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
Since 4.4.0 | Introduced. |
Where the hook is called
rest_pre_dispatch
rest_pre_dispatch
wp-includes/rest-api/class-wp-rest-server.php 972
$result = apply_filters( 'rest_pre_dispatch', null, $this, $request );
wp-includes/rest-api/class-wp-rest-server.php 1567
$result = apply_filters( 'rest_pre_dispatch', null, $this, $clean_request );
Where in WP core the hook is used WordPress
wp-includes/rest-api/class-wp-rest-server.php 211
add_filter( 'rest_pre_dispatch', 'rest_handle_options_request', 10, 3 );