woocommerce_format_stock_quantity

Format the stock quantity ready for display.

Description

(string) apply_filters( 'woocommerce_format_stock_quantity', (int) $stock_quantity, (WC_Product) $product ); 

Returns (string)

Parameters (2)

0. $stock_quantity (int)
The stock quantity.
1. $product (WC_Product)
So that we can pass through the filters.

Usage

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

Defined (1)

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

/includes/wc-formatting-functions.php  
  1. return apply_filters( 'woocommerce_format_stock_quantity', $stock_quantity, $product );