WC_Discounts::validate_coupon_maximum_amount() │ protected │ WC 3.2.0

Ensure coupon amount is valid or throw exception.

Method of the class: WC_Discounts{}

Return

true|false.

Usage

// protected - for code of main (parent) or child class
$result = $this->validate_coupon_maximum_amount( $coupon );

$coupon(WC_Coupon) (required)

Coupon data.

Changelog

WC_Discounts::validate_coupon_maximum_amount() WC Discounts::validate coupon maximum amount code ^{WC 8.7.0}

protected function validate_coupon_maximum_amount( $coupon ) {
	$subtotal = wc_remove_number_precision( $this->get_object_subtotal() );

	if ( $coupon->get_maximum_amount() > 0 && apply_filters( 'woocommerce_coupon_validate_maximum_amount', $coupon->get_maximum_amount() < $subtotal, $coupon ) ) {
		/* translators: %s: coupon maximum amount */
		throw new Exception( sprintf( __( 'The maximum spend for this coupon is %s.', 'woocommerce' ), wc_price( $coupon->get_maximum_amount() ) ), 112 );
	}

	return true;
}