wc_price()
Format the price with a currency symbol.
Hooks from the function
Return
String
.
Usage
wc_price( $price, $args );
- $price(float) (required)
- Raw price.
- $args(array)
- Arguments to format a price {
php Array of arguments. Defaults to empty array.
@type bool $ex_tax_label Adds exclude tax label. Defaults to false. @type string $currency Currency code. Defaults to empty string (Use the result from get_woocommerce_currency()). @type string $decimal_separator Decimal separator. Defaults the result of wc_get_price_decimal_separator(). @type string $thousand_separator Thousand separator. Defaults the result of wc_get_price_thousand_separator(). @type string $decimals Number of decimals. Defaults the result of wc_get_price_decimals(). @type string $price_format Price format depending on the currency position. Defaults the result of get_woocommerce_price_format().
}
Default: array()
wc_price() wc price code WC 9.6.1
function wc_price( $price, $args = array() ) { $args = apply_filters( 'wc_price_args', wp_parse_args( $args, array( 'ex_tax_label' => false, 'currency' => '', 'decimal_separator' => wc_get_price_decimal_separator(), 'thousand_separator' => wc_get_price_thousand_separator(), 'decimals' => wc_get_price_decimals(), 'price_format' => get_woocommerce_price_format(), ) ) ); $original_price = $price; // Convert to float to avoid issues on PHP 8. $price = (float) $price; $unformatted_price = $price; $negative = $price < 0; /** * Filter raw price. * * @param float $raw_price Raw price. * @param float|string $original_price Original price as float, or empty string. Since 5.0.0. */ $price = apply_filters( 'raw_woocommerce_price', $negative ? $price * -1 : $price, $original_price ); /** * Filter formatted price. * * @param float $formatted_price Formatted price. * @param float $price Unformatted price. * @param int $decimals Number of decimals. * @param string $decimal_separator Decimal separator. * @param string $thousand_separator Thousand separator. * @param float|string $original_price Original price as float, or empty string. Since 5.0.0. */ $price = apply_filters( 'formatted_woocommerce_price', number_format( $price, $args['decimals'], $args['decimal_separator'], $args['thousand_separator'] ), $price, $args['decimals'], $args['decimal_separator'], $args['thousand_separator'], $original_price ); if ( apply_filters( 'woocommerce_price_trim_zeros', false ) && $args['decimals'] > 0 ) { $price = wc_trim_zeros( $price ); } $formatted_price = ( $negative ? '-' : '' ) . sprintf( $args['price_format'], '<span class="woocommerce-Price-currencySymbol">' . get_woocommerce_currency_symbol( $args['currency'] ) . '</span>', $price ); $return = '<span class="woocommerce-Price-amount amount"><bdi>' . $formatted_price . '</bdi></span>'; if ( $args['ex_tax_label'] && wc_tax_enabled() ) { $return .= ' <small class="woocommerce-Price-taxLabel tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>'; } /** * Filters the string of price markup. * * @param string $return Price HTML markup. * @param string $price Formatted price. * @param array $args Pass on the args. * @param float $unformatted_price Price as float to allow plugins custom formatting. Since 3.2.0. * @param float|string $original_price Original price as float, or empty string. Since 5.0.0. */ return apply_filters( 'wc_price', $return, $price, $args, $unformatted_price, $original_price ); }