Changeset 57312 for trunk/src/wp-includes/functions.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/functions.php (modified) (3 diffs)

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_serving_rest_request() && 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 ( wp_is_serving_rest_request() ) {
         _doing_it_wrong(
             __FUNCTION__,
@@ -4698 +4698 @@
 }
 
+/**
+ * Determines whether WordPress is currently serving a REST API request.
+ *
+ * The function relies on the 'REST_REQUEST' global. As such, it only returns true when an actual REST _request_ is
+ * being made. It does not return true when a REST endpoint is hit as part of another request, e.g. for preloading a
+ * REST response. See {@see wp_is_rest_endpoint()} for that purpose.
+ *
+ * This function should not be called until the {@see 'parse_request'} action, as the constant is only defined then,
+ * even for an actual REST request.
+ *
+ * @since 6.5.0
+ *
+ * @return bool True if it's a WordPress REST API request, false otherwise.
+ */
+function wp_is_serving_rest_request() {
+    return defined( 'REST_REQUEST' ) && REST_REQUEST;
+}
 
 /**