Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.
WC_Abstract_Order::hold_coupon( WC_Coupon $coupon )
Hold coupon if a global usage limit is defined.
Description Description
Parameters Parameters
- $coupon
-
(Required) Coupon object.
Return Return
(string) Meta key which indicates held coupon.
Source Source
File: includes/abstracts/abstract-wc-order.php
private function hold_coupon( $coupon ) {
$result = $coupon->get_data_store()->check_and_hold_coupon( $coupon );
if ( false === $result ) {
// translators: Actual coupon code.
throw new Exception( sprintf( __( 'An unexpected error happened while applying the Coupon %s.', 'woocommerce' ), esc_html( $coupon->get_code() ) ) );
} elseif ( 0 === $result ) {
// translators: Actual coupon code.
throw new Exception( sprintf( __( 'Coupon %s was used in another transaction during this checkout, and coupon usage limit is reached. Please remove the coupon and try again.', 'woocommerce' ), esc_html( $coupon->get_code() ) ) );
}
return $result;
}