WordPress.org

Make WordPress Core


Ignore:
Timestamp:
05/23/2020 02:34:38 PM (6 months 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/rest-api.php

    r47842 r47849  
    507507 * Ensures a REST response is a response object (for consistency).
    508508 *
    509  * This implements WP_HTTP_Response, allowing usage of `set_status`/`header`/etc
     509 * This implements WP_REST_Response, allowing usage of `set_status`/`header`/etc
    510510 * without needing to double-check the object. Will also allow WP_Error to indicate error
    511511 * responses, so users should immediately check for this value.
     
    513513 * @since 4.4.0
    514514 *
    515  * @param WP_HTTP_Response|WP_Error|mixed $response Response to check.
    516  * @return WP_REST_Response|mixed If response generated an error, WP_Error, if response
    517  *                                is already an instance, WP_HTTP_Response, otherwise
    518  *                                returns a new WP_REST_Response instance.
     515 * @param WP_REST_Response|WP_Error|WP_HTTP_Response|mixed $response Response to check.
     516 * @return WP_REST_Response|WP_Error If response generated an error, WP_Error, if response
     517 *                                   is already an instance, WP_REST_Response, otherwise
     518 *                                   returns a new WP_REST_Response instance.
    519519 */
    520520function rest_ensure_response( $response ) {
     
    523523    }
    524524
     525    if ( $response instanceof WP_REST_Response ) {
     526        return $response;
     527    }
     528
     529    // While WP_HTTP_Response is the base class of WP_REST_Response, it doesn't provide
     530    // all the required methods used in WP_REST_Server::dispatch().
    525531    if ( $response instanceof WP_HTTP_Response ) {
    526         return $response;
     532        return new WP_REST_Response(
     533            $response->get_data(),
     534            $response->get_status(),
     535            $response->get_headers()
     536        );
    527537    }
    528538
Note: See TracChangeset for help on using the changeset viewer.