Changeset 57312

Timestamp:

01/19/2024 05:37:05 PM (7 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.

Location:

trunk

Files:

• src/wp-includes/class-wp-query.php (modified) (1 diff)
• src/wp-includes/deprecated.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (3 diffs)
• src/wp-includes/load.php (modified) (1 diff)
• src/wp-includes/rest-api.php (modified) (2 diffs)
• src/wp-includes/rest-api/class-wp-rest-server.php (modified) (5 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php (modified) (1 diff)
• src/wp-includes/script-loader.php (modified) (1 diff)
• src/wp-includes/user.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/wpIsRestEndpoint.php (added)

trunk/src/wp-includes/class-wp-query.php

@@ -1028 +1028 @@
 
         if ( ! ( $this->is_singular || $this->is_archive || $this->is_search || $this->is_feed
-                || ( defined( 'REST_REQUEST' ) && REST_REQUEST && $this->is_main_query() )
+                || (  && $this->is_main_query() )
                 || $this->is_trackback || $this->is_404 || $this->is_admin || $this->is_robots || $this->is_favicon ) ) {
             $this->is_home = true;

trunk/src/wp-includes/deprecated.php

@@ -5437 +5437 @@
 
         // If in the editor, add webfonts defined in variations.
-        if ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) {
+        if ( is_admin() || ) ) {
             $variations = WP_Theme_JSON_Resolver::get_style_variations();
             foreach ( $variations as $variation ) {

trunk/src/wp-includes/functions.php

@@ -3719 +3719 @@
          */
         $callback = apply_filters( 'wp_die_json_handler', '_json_wp_die_handler' );
-    } elseif ( defined( 'REST_REQUEST' ) && REST_REQUEST && wp_is_jsonp_request() ) {
+    } elseif (  && wp_is_jsonp_request() ) {
         /**
          * Filters the callback for killing WordPress execution for JSONP REST requests.
@@ -4442 +4442 @@
  */
 function wp_send_json( $response, $status_code = null, $flags = 0 ) {
-    if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+    if (  ) {
         _doing_it_wrong(
             __FUNCTION__,
@@ -4698 +4698 @@
 }
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 /**

trunk/src/wp-includes/load.php

@@ -599 +599 @@
     }
 
+
+
+
+
     if ( defined( 'XMLRPC_REQUEST' ) || defined( 'REST_REQUEST' ) || defined( 'MS_FILES_REQUEST' )
         || ( defined( 'WP_INSTALLING' ) && WP_INSTALLING )

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

@@ -210 +210 @@
  */
 function rest_api_default_filters() {
-    if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+    if (  ) {
         // Deprecated reporting.
         add_action( 'deprecated_function_run', 'rest_handle_deprecated_function', 10, 3 );
@@ -3390 +3390 @@
     return new WP_REST_Response( $data, $status );
 }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

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

@@ -87 +87 @@
      */
     protected $embed_cache = array();
+
+
+
+
+
+
+
+
 
     /**
@@ -984 +992 @@
      */
     public function dispatch( $request ) {
+
+
         /**
          * Filters the pre-calculated result of a REST API dispatch request.
@@ -1009 +1019 @@
             }
 
+
             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;
     }
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

@@ -202 +202 @@
         wp_after_insert_post( $attachment, false, null );
 
-        if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+        if (  ) {
             /*
              * Set a custom header with the attachment_id.
@@ -631 +631 @@
         }
 
-        if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+        if (  ) {
             /*
              * Set a custom header with the attachment_id.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php

@@ -129 +129 @@
      * @since 5.9.0
      *
-     * @param WP_REST_REQUEST $request Full details about the request.
+     * @param WP_REST_R $request Full details about the request.
      * @return WP_REST_Response|WP_Error The parsed details as a response object. WP_Error if there are errors.
      */

trunk/src/wp-includes/script-loader.php

@@ -2587 +2587 @@
  */
 function wp_should_load_separate_core_block_assets() {
-    if ( is_admin() || is_feed() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) {
+    if ( is_admin() || is_feed() || ) ) {
         return false;
     }

trunk/src/wp-includes/user.php

@@ -334 +334 @@
     }
 
+
     $is_api_request = ( ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) );