woocommerce_product_is_on_sale

The WooCommerce woocommerce product is on sale hook.

Description

apply_filters( 'woocommerce_product_is_on_sale', (unknown) $on_sale, (unknown) $instance ); 

Parameters (2)

0. $on_sale (unknown)
The on sale.
1. $instance (unknown)
The instance.

Usage

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

Defined (3)

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

/includes/class-wc-product-variable.php  
  1. return 'view' === $context ? apply_filters( 'woocommerce_product_is_on_sale', $on_sale, $this ) : $on_sale; 
/includes/class-wc-product-grouped.php  
  1. return 'view' === $context ? apply_filters( 'woocommerce_product_is_on_sale', $on_sale, $this ) : $on_sale; 
/includes/abstracts/abstract-wc-product.php  
  1. return 'view' === $context ? apply_filters( 'woocommerce_product_is_on_sale', $on_sale, $this ) : $on_sale;