Automattic\WooCommerce\StoreApi\Routes\V1

Checkout::get_route_error_response() │ protected │ WC 1.0

Get route response when something went wrong.

Method of the class: Checkout{}

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: []

Checkout::get_route_error_response() Checkout::get route error response code ^{WC 9.3.1}

protected function get_route_error_response( $error_code, $error_message, $http_status_code = 500, $additional_data = [] ) {
	$error_from_message = new \WP_Error(
		$error_code,
		$error_message
	);
	// 409 is when there was a conflict, so we return the cart so the client can resolve it.
	if ( 409 === $http_status_code ) {
		return $this->add_data_to_error_object( $error_from_message, $additional_data, $http_status_code, true );
	}
	return $this->add_data_to_error_object( $error_from_message, $additional_data, $http_status_code );
}