woocommerce_cart_totals_coupon_label

The WooCommerce woocommerce cart totals coupon label hook.

Description

apply_filters( 'woocommerce_cart_totals_coupon_label', (unknown) $sprintf, (unknown) $coupon ); 

Parameters (2)

0. $sprintf (unknown) => sprintf( esc_html__( 'Coupon: %s', 'woocommerce' ), $coupon->get_code() )
The sprintf.
1. $coupon (unknown)
The coupon.

Usage

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

Defined (1)

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

/includes/wc-cart-functions.php  
  1. $label = apply_filters( 'woocommerce_cart_totals_coupon_label', sprintf( esc_html__( 'Coupon: %s', 'woocommerce' ), $coupon->get_code() ), $coupon );