WC_Cart::remove_coupon │ public │ WC 1.0

Remove a single coupon by code.

Method of the class: WC_Cart{}

Returns

true|false.

Usage

$WC_Cart = new WC_Cart();
$WC_Cart->remove_coupon( $coupon_code );

$coupon_code(string) (required)

Code of the coupon to remove.

WC_Cart::remove_coupon() WC Cart::remove coupon code ^{WC 10.6.2}

public function remove_coupon( $coupon_code ) {
	$coupon_code = wc_format_coupon_code( $coupon_code );

	// Find the coupon in applied coupons using case-insensitive comparison.
	foreach ( $this->get_applied_coupons() as $key => $applied_coupon ) {
		if ( wc_is_same_coupon( $applied_coupon, $coupon_code ) ) {
			unset( $this->applied_coupons[ $key ] );
			break;
		}
	}

	WC()->session->set( 'refresh_totals', true );

	do_action( 'woocommerce_removed_coupon', $coupon_code );

	return true;
}