Automattic\WooCommerce\StoreApi\Routes\V1

AbstractRoute::get_route_error_response_from_object()protectedWC 1.0

Get route response when something went wrong and the supplied error is a WP_Error. This currently only happens when an item in the cart is out of stock, partially out of stock, can only be bought individually, or when the item is not purchasable.

Method of the class: AbstractRoute{}

No Hooks.

Return

WP_Error. WP Error object.

Usage

// protected - for code of main (parent) or child class
$result = $this->get_route_error_response_from_object( $error_object, $http_status_code, $additional_data );
$error_object(WP_Error) (required)
The WP_Error object containing the error.
$http_status_code(int)
HTTP status.
Default: 500
$additional_data(array)
Extra data (key value pairs) to expose in the error response.
Default: []

AbstractRoute::get_route_error_response_from_object() code WC 8.7.0

protected function get_route_error_response_from_object( $error_object, $http_status_code = 500, $additional_data = [] ) {
	$error_object->add_data( array_merge( $additional_data, [ 'status' => $http_status_code ] ) );
	return $error_object;
}