wc_format_stock_for_display( WC_Product $product )
Format the stock amount ready for display based on settings.
Description Description
Parameters Parameters
- $product
-
(Required) Product object for which the stock you need to format.
Return Return
(string)
Source Source
File: includes/wc-formatting-functions.php
function wc_format_stock_for_display( $product ) { $display = __( 'In stock', 'woocommerce' ); $stock_amount = $product->get_stock_quantity(); switch ( get_option( 'woocommerce_stock_format' ) ) { case 'low_amount': if ( $stock_amount <= get_option( 'woocommerce_notify_low_stock_amount' ) ) { /* translators: %s: stock amount */ $display = sprintf( __( 'Only %s left in stock', 'woocommerce' ), wc_format_stock_quantity_for_display( $stock_amount, $product ) ); } break; case '': /* translators: %s: stock amount */ $display = sprintf( __( '%s in stock', 'woocommerce' ), wc_format_stock_quantity_for_display( $stock_amount, $product ) ); break; } if ( $product->backorders_allowed() && $product->backorders_require_notification() ) { $display .= ' ' . __( '(can be backordered)', 'woocommerce' ); } return $display; }
Changelog Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |