woocommerce_stock_amount

Formats a stock amount by running it through a filter.

Description

(int|float) apply_filters( 'woocommerce_stock_amount', (number) $amount ); 

Returns (int|float)

Parameters (1)

0. $amount (number)
The amount.

Usage

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

Defined (1)

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

/includes/wc-formatting-functions.php  
  1. return apply_filters( 'woocommerce_stock_amount', $amount );