WC_Cart::remove_coupon( string $coupon_code )

Remove a single coupon by code.


Description Description


Parameters Parameters

$coupon_code

(Required) Code of the coupon to remove.


Top ↑

Return Return

(bool)


Top ↑

Source Source

File: includes/class-wc-cart.php

	public function remove_coupon( $coupon_code ) {
		$coupon_code = wc_format_coupon_code( $coupon_code );
		$position    = array_search( $coupon_code, $this->get_applied_coupons(), true );

		if ( false !== $position ) {
			unset( $this->applied_coupons[ $position ] );
		}

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

		do_action( 'woocommerce_removed_coupon', $coupon_code );

		return true;
	}


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.