WordPress at Your Fingertips
function is not described

Automattic\WooCommerce\Blocks\StoreApi\Routes

AbstractCartRoute::get_route_error_response() protected WC 1.0

Get route response when something went wrong.

{} It's a method of the class: AbstractCartRoute{}

No Hooks.

Return

\WP_Error. WP Error object.

Usage

// protected - for code of main (parent) or child class
$result = $this->get_route_error_response( $error_code, $error_message, $http_status_code, $additional_data );
$error_code(string) (required)
String based error code.
$error_message(string) (required)
User facing error message.
$http_status_code(int)
HTTP status.
Default: 500
$additional_data(array)
Extra data (key value pairs) to expose in the error response.
Default: []

Code of AbstractCartRoute::get_route_error_response() WC 5.7.0

protected function get_route_error_response( $error_code, $error_message, $http_status_code = 500, $additional_data = [] ) {
	switch ( $http_status_code ) {
		case 409:
			// If there was a conflict, return the cart so the client can resolve it.
			$cart = $this->cart_controller->get_cart_instance();

			return new \WP_Error(
				$error_code,
				$error_message,
				array_merge(
					$additional_data,
					[
						'status' => $http_status_code,
						'cart'   => $this->cart_schema->get_item_response( $cart ),
					]
				)
			);
	}
	return new \WP_Error( $error_code, $error_message, [ 'status' => $http_status_code ] );
}