woocommerce_product_is_in_stock

Returns whether or not the product is in stock.

Description

apply_filters( 'woocommerce_product_is_in_stock', (string) $instock_this_get_stock_status, (unknown) $instance ); 

Parameters (2)

0. $instock_this_get_stock_status — Optional. (string) => 'instock' === $this->get_stock_status()
The instock this get stock status.
1. $instance (unknown)
The instance.

Usage

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

Defined (1)

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

/includes/abstracts/abstract-wc-product.php  
  1. return apply_filters( 'woocommerce_product_is_in_stock', 'instock' === $this->get_stock_status(), $this );