woocommerce_coupon_error

The WooCommerce woocommerce coupon error hook.

Description

apply_filters( 'woocommerce_coupon_error', (unknown) $err, (unknown) $err_code, (unknown) $instance ); 

Parameters (3)

0. $err (unknown)
The err.
1. $err_code (unknown)
The err code.
2. $instance (unknown)
The instance.

Usage

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

Defined (2)

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

/includes/class-wc-coupon.php  
  1. return apply_filters( 'woocommerce_coupon_error', $err, $err_code, $this ); 
  1. return apply_filters( 'woocommerce_coupon_error', $err, $err_code, null );