rest_request_before_callbacks WordPress Filter Hook

The rest_request_before_callbacks hook is called before the HTTP request is sent to the server. This hook allows you to modify the request before it is sent, or even cancel the request altogether. This hook is useful for making sure that the request contains all the necessary data, or for adding authentication information to the request.

apply_filters( 'rest_request_before_callbacks', WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response, array $handler, WP_REST_Request $request ) #

Filters the response before executing any REST API callbacks.


Description

Allows plugins to perform additional validation after a request is initialized and matched to a registered route, but before it is executed.

Note that this filter will not be called for requests that fail to authenticate or match to a registered route.


Top ↑

Parameters

$response

(WP_REST_Response|WP_HTTP_Response|WP_Error|mixed)Result to send to the client. Usually a WP_REST_Response or WP_Error.

$handler

(array)Route handler used for the request.

$request

(WP_REST_Request)Request used to generate the response.


Top ↑

Source

File: wp-includes/rest-api/class-wp-rest-server.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.