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_Abilities_V1_Categories_Controller::get_item()Retrieves a specific ability category.
• WP_REST_Abilities_V1_Categories_Controller::get_items()Retrieves all ability categories.
• WP_REST_Abilities_V1_Categories_Controller::prepare_item_for_response()Prepares an ability category for response.
• WP_REST_Abilities_V1_List_Controller::get_item()Retrieves a specific ability.
• WP_REST_Abilities_V1_List_Controller::get_items()Retrieves all abilities.
• WP_REST_Abilities_V1_List_Controller::prepare_item_for_response()Prepares an ability for response.
• WP_REST_Abilities_V1_Run_Controller::execute_ability()Executes an ability.
• 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::sideload_item()Side-loads a media file without creating a new attachment.
• WP_REST_Attachments_Controller::update_item()Updates a single attachment.
• WP_REST_Autosaves_Controller::create_item()Creates, updates or deletes an autosave revision.

Source

View on Trac ↗View on GitHub ↗

698function rest_ensure_response( $response ) {699	if ( is_wp_error( $response ) ) {700		return $response;701	}702 703	if ( $response instanceof WP_REST_Response ) {704		return $response;705	}706 707	/*708	 * While WP_HTTP_Response is the base class of WP_REST_Response, it doesn't provide709	 * all the required methods used in WP_REST_Server::dispatch().710	 */711	if ( $response instanceof WP_HTTP_Response ) {712		return new WP_REST_Response(713			$response->get_data(),714			$response->get_status(),715			$response->get_headers()716		);717	}718 719	return new WP_REST_Response( $response );720}

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 7.1.0 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.