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

Timestamp:

05/23/2020 02:34:38 PM (5 years ago)

Author:

ocean90

Message:

Rest API: Ensure rest_ensure_response() upgrades WP_HTTP_Response to WP_REST_Response.

An instance of WP_HTTP_Response doesn't ensure that the required methods used in WP_REST_Server::dispatch() exist, currently causing a fatal error.

Props ali11007, TimothyBlynJacobs, ocean90.
Fixes #49495.

File:

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

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

@@ -507 +507 @@
  * Ensures a REST response is a response object (for consistency).
  *
- * This implements WP_HTTP_Response, allowing usage of `set_status`/`header`/etc
+ * This implements WP_REST_Response, allowing usage of `set_status`/`header`/etc
  * without needing to double-check the object. Will also allow WP_Error to indicate error
  * responses, so users should immediately check for this value.
@@ -513 +513 @@
  * @since 4.4.0
  *
- * @param WP_HTTP_Response|WP_Error|mixed $response Response to check.
- * @return WP_REST_Response|mixed If response generated an error, WP_Error, if response
- *                                is already an instance, WP_HTTP_Response, otherwise
- *                                returns a new WP_REST_Response instance.
+ * @param WP_REST_Response|WP_Error|WP_HTTP_Response|mixed $response Response to check.
+ * @return WP_REST_Response|WP_Error If response generated an error, WP_Error, if response
+ *                                   is already an instance, WP_REST_Response, otherwise
+ *                                   returns a new WP_REST_Response instance.
  */
 function rest_ensure_response( $response ) {
@@ -523 +523 @@
     }
 
+    if ( $response instanceof WP_REST_Response ) {
+        return $response;
+    }
+
+    // While WP_HTTP_Response is the base class of WP_REST_Response, it doesn't provide
+    // all the required methods used in WP_REST_Server::dispatch().
     if ( $response instanceof WP_HTTP_Response ) {
-        return $response;
+        return new WP_REST_Response(
+            $response->get_data(),
+            $response->get_status(),
+            $response->get_headers()
+        );
     }