wp_is_rest_endpoint(): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

bool

True if a REST endpoint request is currently being handled, false otherwise.

Performance profile

How much work a call to wp_is_rest_endpoint() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11–17

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 17.

Plugin surface

1 hook

Third-party callbacks on 'wp_is_rest_endpoint' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_is_rest_endpoint() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_is_rest_endpoint() runs, in this order:

1. 1
   apply_filters( wp_is_rest_endpoint )filterline 3543 (+21 into the body)

   Filters whether a REST endpoint request is currently being handled.

Uses · 2

• wp_is_serving_rest_request()Determines whether WordPress is currently serving a REST API request.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 3

• _wp_theme_json_webfonts_handler()Runs the theme.json webfonts handler.
• wp_should_load_block_assets_on_demand()Checks whether block styles should be loaded only on-render.
• wp_should_load_separate_core_block_assets()Checks whether separate styles should be loaded for core blocks.

Source code

View on Trac ↗View on GitHub ↗

3522function wp_is_rest_endpoint() {3523	/* @var WP_REST_Server $wp_rest_server */3524	global $wp_rest_server;3525 3526	// Check whether this is a standalone REST request.3527	$is_rest_endpoint = wp_is_serving_rest_request();3528	if ( ! $is_rest_endpoint ) {3529		// Otherwise, check whether an internal REST request is currently being handled.3530		$is_rest_endpoint = isset( $wp_rest_server )3531			&& $wp_rest_server->is_dispatching();3532	}3533 3534	/**3535	 * Filters whether a REST endpoint request is currently being handled.3536	 *3537	 * This may be a standalone REST API request, or an internal request dispatched from within a regular page load.3538	 *3539	 * @since 6.5.03540	 *3541	 * @param bool $is_request_endpoint Whether a REST endpoint request is currently being handled.3542	 */3543	return (bool) apply_filters( 'wp_is_rest_endpoint', $is_rest_endpoint );3544}

Changelog

Introduced in 6.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.