WC_Cart::get_coupon_discount_amount │ public │ WC 1.0

Get the discount amount for a used coupon.

Method of the class: WC_Cart{}

No Hooks.

Returns

float. discount amount

Usage

$WC_Cart = new WC_Cart();
$WC_Cart->get_coupon_discount_amount( $code, $ex_tax );

$code(string) (required)

coupon code.

$ex_tax(true|false)

inc or ex tax.
Default: true

WC_Cart::get_coupon_discount_amount() WC Cart::get coupon discount amount code ^{WC 10.7.0}

public function get_coupon_discount_amount( $code, $ex_tax = true ) {
	$totals          = $this->get_coupon_discount_totals();
	$discount_amount = 0;
	foreach ( $totals as $key => $value ) {
		if ( wc_is_same_coupon( $key, $code ) ) {
			$discount_amount = $value;
			break;
		}
	}

	if ( ! $ex_tax ) {
		$discount_amount += $this->get_coupon_discount_tax_amount( $code );
	}

	return wc_cart_round_discount( $discount_amount, wc_get_price_decimals() );
}