Changeset 57312 for trunk/src/wp-includes/rest-api.php

Timestamp:

01/19/2024 05:37:05 PM (11 months ago)

Author:

flixos90

Message:

Bootstrap/Load: Introduce functions to check whether WordPress is serving a REST API request.

This changeset introduces two functions:

• wp_is_serving_rest_request() returns a boolean for whether WordPress is serving an actual REST API request.
• wp_is_rest_endpoint() returns a boolean for whether a WordPress REST API endpoint is currently being used. While this is always the case if wp_is_serving_rest_request() returns true, the function additionally covers the scenario of internal REST API requests, i.e. where WordPress calls a REST API endpoint within the same request.

Both functions should only be used after the parse_request action.

All relevant manual checks have been adjusted to use one of the new functions, depending on the use-case. They were all using the same constant check so far, while in fact some of them were intending to check for an actual REST API request while others were intending to check for REST endpoint usage.

A new filter wp_is_rest_endpoint can be used to alter the return value of the wp_is_rest_endpoint() function.

Props lots.0.logs, TimothyBlynJacobs, flixos90, joehoyle, peterwilsoncc, swissspidy, SergeyBiryukov, pento, mikejolley, iandunn, hellofromTonya, Cybr, petitphp.
Fixes #42061.

File:

• trunk/src/wp-includes/rest-api.php (modified) (2 diffs)

trunk/src/wp-includes/rest-api.php

@@ -210 +210 @@
  */
 function rest_api_default_filters() {
-    if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+    if ( wp_is_serving_rest_request() ) {
         // Deprecated reporting.
         add_action( 'deprecated_function_run', 'rest_handle_deprecated_function', 10, 3 );
@@ -3390 +3390 @@
     return new WP_REST_Response( $data, $status );
 }
+
+/**
+ * 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.
+ *
+ * @since 6.5.0
+ *
+ * @global WP_REST_Server $wp_rest_server REST server instance.
+ *
+ * @return bool True if a REST endpoint request is currently being handled, false otherwise.
+ */
+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 );
+}