wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_is_rest_endpoint › WordPress Function

Since6.5.0
Deprecatedn/a
wp_is_rest_endpoint ( No parameters )
Returns:
  • (bool) True if a REST endpoint request is currently being handled, false otherwise.
Defined at:
Codex:

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

This may be a standalone REST API request, or an internal request dispatched from within a regular page load.


Source

function wp_is_rest_endpoint() {
	/* @var WP_REST_Server $wp_rest_server */
	global $wp_rest_server;

	// Check whether this is a standalone REST request.
	$is_rest_endpoint = wp_is_serving_rest_request();
	if ( ! $is_rest_endpoint ) {
		// Otherwise, check whether an internal REST request is currently being handled.
		$is_rest_endpoint = isset( $wp_rest_server )
			&& $wp_rest_server->is_dispatching();
	}

	/**
	 * Filters whether a REST endpoint request is currently being handled.
	 *
	 * This may be a standalone REST API request, or an internal request dispatched from within a regular page load.
	 *
	 * @since 6.5.0
	 *
	 * @param bool $is_request_endpoint Whether a REST endpoint request is currently being handled.
	 */
	return (bool) apply_filters( 'wp_is_rest_endpoint', $is_rest_endpoint );
}