WordPress at Your Fingertips
function is not described

WC_Coupon::set_amount() public WC 3.0.0

Set amount.

{} It's a method of the class: WC_Coupon{}

No Hooks.

Return

null. Nothing.

Usage

$WC_Coupon = new WC_Coupon();
$WC_Coupon->set_amount( $amount );
$amount(float) (required)
Amount.

Changelog

Since 3.0.0 Introduced.

Code of WC_Coupon::set_amount() WC 5.6.0

public function set_amount( $amount ) {
	$amount = wc_format_decimal( $amount );

	if ( ! is_numeric( $amount ) ) {
		$amount = 0;
	}

	if ( $amount < 0 ) {
		$this->error( 'coupon_invalid_amount', __( 'Invalid discount amount', 'woocommerce' ) );
	}

	if ( 'percent' === $this->get_discount_type() && $amount > 100 ) {
		$this->error( 'coupon_invalid_amount', __( 'Invalid discount amount', 'woocommerce' ) );
	}

	$this->set_prop( 'amount', $amount );
}