wpseek.com
A WordPress-centric search engine for devs and theme authors



rest_ensure_response › WordPress Function

Since4.4.0
Deprecatedn/a
› rest_ensure_response ( $response )
Parameters:
  • (WP_REST_Response|WP_Error|WP_HTTP_Response|mixed) $response Response to check.
    Required: Yes
Returns:
  • (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.
Defined at:
Codex:

Ensures a REST response is a response object (for consistency).

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.


Related Functions: rest_ensure_request, rest_filter_response_fields, rest_convert_error_to_response, get_oembed_response_data, rest_filter_response_by_context

Source 

function rest_ensure_response( $response ) {
	if ( is_wp_error( $response ) ) {
		return $response;
	}

	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 new WP_REST_Response(
			$response->get_data(),
			$response->get_status(),
			$response->get_headers()
		);
	}

	return new WP_REST_Response( $response );
}