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

Timestamp:

01/19/2024 05:37:05 PM (8 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/class-wp-rest-server.php (modified) (5 diffs)

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

@@ -87 +87 @@
      */
     protected $embed_cache = array();
+
+    /**
+     * Stores request objects that are currently being handled.
+     *
+     * @since 6.5.0
+     * @var array
+     */
+    protected $dispatching_requests = array();
 
     /**
@@ -984 +992 @@
      */
     public function dispatch( $request ) {
+        $this->dispatching_requests[] = $request;
+
         /**
          * Filters the pre-calculated result of a REST API dispatch request.
@@ -1009 +1019 @@
             }
 
+            array_pop( $this->dispatching_requests );
             return $result;
         }
@@ -1016 +1027 @@
 
         if ( is_wp_error( $matched ) ) {
-            return $this->error_to_response( $matched );
+            $response = $this->error_to_response( $matched );
+            array_pop( $this->dispatching_requests );
+            return $response;
         }
 
@@ -1041 +1054 @@
         }
 
-        return $this->respond_to_request( $request, $route, $handler, $error );
+        $response = $this->respond_to_request( $request, $route, $handler, $error );
+        array_pop( $this->dispatching_requests );
+        return $response;
+    }
+
+    /**
+     * Returns whether the REST server is currently dispatching / responding to a request.
+     *
+     * This may be a standalone REST API request, or an internal request dispatched from within a regular page load.
+     *
+     * @since 6.5.0
+     *
+     * @return bool Whether the REST server is currently handling a request.
+     */
+    public function is_dispatching() {
+        return (bool) $this->dispatching_requests;
     }