wp_is_serving_rest_request()

Determines whether WordPress is currently serving a REST API request.

Description

The function relies on the ‘REST_REQUEST’ global. As such, it only returns true when an actual REST request is being made. It does not return true when a REST endpoint is hit as part of another request, e.g. for preloading a REST response. See wp_is_rest_endpoint() for that purpose.

This function should not be called until the ‘parse_request’ action, as the constant is only defined then, even for an actual REST request.

Return

(bool) True if it's a WordPress REST API request, false otherwise.

Source

File: wp-includes/functions.php

function wp_is_serving_rest_request() {
	return defined( 'REST_REQUEST' ) && REST_REQUEST;
}

Expand Source Code View on GitHub

Used By

Used By
Used By	Description
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::edit_media_item()	Applies edits to a media item and creates a new attachment record.
wp-includes/rest-api.php: wp_is_rest_endpoint()	Checks whether a REST API endpoint request is currently being handled.
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::create_item()	Creates a single attachment.
wp-includes/class-wp-query.php: WP_Query::parse_query()	Parse a query string and set query type booleans.
wp-includes/rest-api.php: rest_api_default_filters()	Registers the default REST API filters.
wp-includes/functions.php: wp_send_json()	Sends a JSON response back to an Ajax request.
wp-includes/functions.php: wp_die()	Kills WordPress execution and displays HTML page with an error message.

Show 2 more used by Hide more used by

Changelog

Changelog
Version	Description
6.5.0	Introduced.