Get WordPress

WordPress Developer Resources

wp_is_serving_rest_request()

wp_is_serving_rest_request(): bool

In this article

Back to top

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

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

View all references View on Trac View on GitHub

Used byDescription
wp_is_rest_endpoint()wp-includes/rest-api.php

Checks whether a REST API endpoint request is currently being handled.

WP_REST_Attachments_Controller::edit_media_item()wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

Applies edits to a media item and creates a new attachment record.

WP_REST_Attachments_Controller::create_item()wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

Creates a single attachment.

rest_api_default_filters()wp-includes/rest-api.php

Registers the default REST API filters.

WP_Query::parse_query()wp-includes/class-wp-query.php

Parses a query string and sets query type booleans.

wp_send_json()wp-includes/functions.php

Sends a JSON response back to an Ajax request.

wp_die()wp-includes/functions.php

Kills WordPress execution and displays HTML page with an error message.

Show 2 moreShow less

Changelog

VersionDescription
6.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.