rest_ensure_response( WP_REST_Response|WP_Error|WP_HTTP_Response|mixed $response ): WP_REST_Response|WP_Error

Description

Parameters

$responseWP_REST_Response|WP_Error|WP_HTTP_Response|mixed

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.

Uses · 2

• is_wp_error()Checks whether the given variable is a WordPress Error.
• WP_REST_Response::__construct()

Used by · 50

• WP_REST_Attachments_Controller::create_item()Creates a single attachment.
• WP_REST_Attachments_Controller::prepare_item_for_response()Prepares a single attachment output for response.
• WP_REST_Attachments_Controller::update_item()Updates a single attachment.
• WP_REST_Autosaves_Controller::create_item()Creates, updates or deletes an autosave revision.
• WP_REST_Autosaves_Controller::get_items()Gets a collection of autosaves using wp_get_post_autosave.
• WP_REST_Block_Directory_Controller::get_items()Search and retrieve blocks metadata
• WP_REST_Block_Pattern_Categories_Controller::get_items()Retrieves all block pattern categories.
• WP_REST_Block_Pattern_Categories_Controller::prepare_item_for_response()Prepare a raw block pattern category before it gets output in a REST API response.
• WP_REST_Block_Patterns_Controller::get_items()Retrieves all block patterns.
• WP_REST_Block_Patterns_Controller::prepare_item_for_response()Prepare a raw block pattern before it gets output in a REST API response.
• WP_REST_Block_Renderer_Controller::get_item()Returns block output from block's registered render_callback.
• WP_REST_Block_Types_Controller::get_item()Retrieves a specific block type.

Source

View on Trac ↗View on GitHub ↗

678function rest_ensure_response( $response ) {679	if ( is_wp_error( $response ) ) {680		return $response;681	}682 683	if ( $response instanceof WP_REST_Response ) {684		return $response;685	}686 687	/*688	 * While WP_HTTP_Response is the base class of WP_REST_Response, it doesn't provide689	 * all the required methods used in WP_REST_Server::dispatch().690	 */691	if ( $response instanceof WP_HTTP_Response ) {692		return new WP_REST_Response(693			$response->get_data(),694			$response->get_status(),695			$response->get_headers()696		);697	}698 699	return new WP_REST_Response( $response );700}

History

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/rest-api.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.