Automattic\WooCommerce\StoreApi\Utilities

OrderController::validate_order_key() │ public │ WC 1.0

Validate a given order key against an existing order.

Method of the class: OrderController{}

No Hooks.

Return

null. Nothing (null).

Usage

$OrderController = new OrderController();
$OrderController->validate_order_key( $order_id, $order_key );

$order_id(int) (required)

Order ID.

$order_key(string) (required)

Order key.

OrderController::validate_order_key() OrderController::validate order key code ^{WC 9.5.1}

public function validate_order_key( $order_id, $order_key ) {
	$order = wc_get_order( $order_id );

	if ( ! $order || ! $order_key || $order->get_id() !== $order_id || ! hash_equals( $order->get_order_key(), $order_key ) ) {
		throw new RouteException( 'woocommerce_rest_invalid_order', __( 'Invalid order ID or key provided.', 'woocommerce' ), 401 );
	}
}