woocommerce_cart_total_discount

The WooCommerce woocommerce cart total discount hook.

Description

apply_filters( 'woocommerce_cart_total_discount', (number) $total_discount, (unknown) $instance ); 

Parameters (2)

0. $total_discount (number)
The total discount.
1. $instance (unknown)
The instance.

Usage

To run the hook, copy the example below.
  1. $total_discount = apply_filters( 'woocommerce_cart_total_discount', $total_discount, $instance ); 
  2.  
  3. if ( !empty( $total_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_cart_total_discount callback 
  2. function filter_woocommerce_cart_total_discount( $total_discount, $instance ) { 
  3. // make filter magic happen here... 
  4. return $total_discount
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_cart_total_discount', 'filter_woocommerce_cart_total_discount', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_cart_total_discount', 'filter_woocommerce_cart_total_discount', 10, 2 ); 

Defined (1)

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

/includes/class-wc-cart.php  
  1. return apply_filters( 'woocommerce_cart_total_discount', $total_discount, $this );