woocommerce_coupon_get_discount_amount

The WooCommerce woocommerce coupon get discount amount hook.

Description

apply_filters( 'woocommerce_coupon_get_discount_amount', (number) $discount, (number) $discounting_amount, (unknown) $cart_item, (unknown) $single, (unknown) $instance ); 

Parameters (5)

0. $discount (number)
The discount.
1. $discounting_amount (number)
The discounting amount.
2. $cart_item (unknown)
The cart item.
3. $single (unknown)
The single.
4. $instance (unknown)
The instance.

Usage

To run the hook, copy the example below.
  1. $discount = apply_filters( 'woocommerce_coupon_get_discount_amount', $discount, $discounting_amount, $cart_item, $single, $instance ); 
  2.  
  3. if ( !empty( $discount ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the woocommerce_coupon_get_discount_amount callback 
  2. function filter_woocommerce_coupon_get_discount_amount( $discount, $discounting_amount, $cart_item, $single, $instance ) { 
  3. // make filter magic happen here... 
  4. return $discount
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_coupon_get_discount_amount', 'filter_woocommerce_coupon_get_discount_amount', 10, 5 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_coupon_get_discount_amount', 'filter_woocommerce_coupon_get_discount_amount', 10, 5 ); 

Defined (1)

The filter is defined in the following location(s).

/includes/class-wc-coupon.php  
  1. return apply_filters( 'woocommerce_coupon_get_discount_amount', $discount, $discounting_amount, $cart_item, $single, $this );