wc_price( float $price, array $args = array() )

Format the price with a currency symbol.

Contents

Description Description

Parameters Parameters

$price

(Required) Raw price.

$args

(Optional) Arguments to format a price { 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 value: array()

Top ↑

Return Return

(string)

Top ↑

Source Source

File: includes/wc-formatting-functions.php 

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(),
			)
		)
	);

	$unformatted_price = $price;
	$negative          = $price < 0;
	$price             = apply_filters( 'raw_woocommerce_price', floatval( $negative ? $price * -1 : $price ) );
	$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'] );

	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">' . $formatted_price . '</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.
	 */
	return apply_filters( 'wc_price', $return, $price, $args, $unformatted_price );
}

Expand full source code Collapse full source code

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
includes/wc-formatting-functions.php: raw_woocommerce_price

Filter raw price.
includes/wc-formatting-functions.php: formatted_woocommerce_price

Filter formatted price.
woocommerce.php: WC()

Returns the main instance of WC.
includes/wc-formatting-functions.php: wc_get_price_decimal_separator()

Return the decimal separator for prices.
includes/wc-formatting-functions.php: wc_get_price_decimals()

Return the number of decimals after the decimal point.
includes/wc-formatting-functions.php: wc_price

Filters the string of price markup.
includes/wc-formatting-functions.php: wc_get_price_thousand_separator()

Return the thousand separator for prices.
includes/wc-formatting-functions.php: get_woocommerce_price_format()

Get the price format depending on the currency position.
includes/wc-formatting-functions.php: wc_trim_zeros()

Trim trailing zeros off prices.
includes/wc-core-functions.php: get_woocommerce_currency_symbol()

Get Currency symbol.
includes/wc-conditional-functions.php: wc_tax_enabled()

Are store-wide taxes enabled?
Show 6 more uses Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
includes/admin/class-wc-admin-dashboard.php: WC_Admin_Dashboard::sales_sparkline()

Overwrites the original sparkline to use the new reports data if WooAdmin is enabled.
packages/woocommerce-admin/src/Notes/NewSalesRecord.php: NewSalesRecord::possibly_add_note()

Possibly add a sales record note.
includes/class-wc-discounts.php: WC_Discounts::validate_coupon_minimum_amount()

Ensure coupon amount is valid or throw exception.
includes/class-wc-discounts.php: WC_Discounts::validate_coupon_maximum_amount()

Ensure coupon amount is valid or throw exception.
includes/wc-formatting-functions.php: wc_format_price_range()

Format a price range for display.
includes/wc-formatting-functions.php: wc_format_sale_price()

Format a sale price for display.
includes/admin/class-wc-admin-dashboard.php: WC_Admin_Dashboard::status_widget()

Show status widget.
includes/admin/list-tables/class-wc-admin-list-table-orders.php: WC_Admin_List_Table_Orders::get_order_preview_item_html()

Get items to display in the preview as HTML.
includes/admin/reports/class-wc-report-customer-list.php: WC_Report_Customer_List::column_default()

Get column value.
includes/admin/reports/class-wc-report-coupon-usage.php: WC_Report_Coupon_Usage::get_chart_legend()

Get the legend for the main chart sidebar.
includes/admin/reports/class-wc-report-coupon-usage.php: WC_Report_Coupon_Usage::coupons_widget()

Output coupons widget.
includes/admin/reports/class-wc-report-sales-by-date.php: WC_Report_Sales_By_Date::get_chart_legend()

Get the legend for the main chart sidebar.
includes/admin/reports/class-wc-report-taxes-by-date.php: WC_Report_Taxes_By_Date::get_main_chart()

Get the main chart.
includes/admin/reports/class-wc-report-sales-by-category.php: WC_Report_Sales_By_Category::get_chart_legend()

Get the legend for the main chart sidebar.
includes/admin/reports/class-wc-report-taxes-by-code.php: WC_Report_Taxes_By_Code::get_main_chart()

Get the main chart.
includes/admin/reports/class-wc-report-sales-by-product.php: WC_Report_Sales_By_Product::get_chart_legend()

Get the legend for the main chart sidebar.
includes/admin/reports/class-wc-report-sales-by-product.php: WC_Report_Sales_By_Product::products_widget()

Output products widget.
includes/admin/reports/class-wc-admin-report.php: WC_Admin_Report::sales_sparkline()

Prepares a sparkline to show sales in the last X days.
includes/class-wc-product-grouped.php: WC_Product_Grouped::get_price_html()

Returns the price in html format.
includes/class-wc-order.php: WC_Order::add_order_item_totals_refund_rows()

Add total row for refunds.
includes/class-wc-order.php: WC_Order::get_formatted_order_total()

Gets order total – formatted for display.
includes/legacy/class-wc-legacy-cart.php: WC_Legacy_Cart::get_discounts_before_tax()

Gets the total (product) discount amount – these are applied before tax.
includes/class-wc-cart.php: WC_Cart::get_total_discount()

Gets the total discount amount.
includes/class-wc-cart.php: WC_Cart::get_total_ex_tax()

Gets the total excluding taxes.
includes/class-wc-cart.php: WC_Cart::get_cart_total()

Gets the cart contents total (after calculation).
includes/class-wc-cart.php: WC_Cart::get_cart_subtotal()

Gets the sub total (after calculation).
includes/class-wc-cart.php: WC_Cart::get_product_price()

Get the product row price per item.
includes/class-wc-cart.php: WC_Cart::get_product_subtotal()

Get the product row subtotal.
includes/class-wc-cart.php: WC_Cart::get_cart_tax()

Gets the cart tax (after calculation).
includes/class-wc-cart.php: WC_Cart::get_cart_shipping_total()

Gets the shipping total (after calculation).
includes/class-wc-cart.php: WC_Cart::get_tax_totals()

Get taxes, merged by code, formatted ready for output.
includes/class-wc-cart.php: WC_Cart::get_total()

Gets cart total after calculation.
includes/class-wc-ajax.php: WC_AJAX::add_order_fee()

Add order fee via ajax.
includes/wc-cart-functions.php: wc_cart_totals_shipping_method_label()

Get a shipping methods full label including price.
includes/wc-cart-functions.php: wc_cart_totals_coupon_html()

Get coupon display HTML.
includes/wc-cart-functions.php: wc_cart_totals_order_total_html()

Get order total html including inc tax if needed.
includes/wc-cart-functions.php: wc_cart_totals_fee_html()

Get the fee value.
includes/wc-cart-functions.php: wc_cart_totals_taxes_total_html()

Get taxes total.
includes/widgets/class-wc-widget-layered-nav-filters.php: WC_Widget_Layered_Nav_Filters::widget()

Output widget.
includes/class-wc-product-variable.php: WC_Product_Variable::get_price_html()

Returns the price in html format.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::add_order_item_totals_fee_rows()

Add total row for fees.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::add_order_item_totals_tax_rows()

Add total row for taxes.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::get_formatted_order_total()

Gets order total – formatted for display.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::get_subtotal_to_display()

Gets subtotal – subtotal is shown before discounts, but with localised taxes.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::get_shipping_to_display()

Gets shipping (formatted).
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::get_discount_to_display()

Get the discount amount (formatted).
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::get_formatted_line_subtotal()

Gets line subtotal – formatted for display.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::get_tax_totals()

Get taxes, merged by code, formatted ready for output.
includes/abstracts/abstract-wc-product.php: WC_Product::get_price_suffix()

Get the suffix to display after prices > 0.
includes/abstracts/abstract-wc-product.php: WC_Product::get_price_html()

Returns the price in html format.
includes/wc-deprecated-functions.php: woocommerce_price()
includes/class-wc-coupon.php: WC_Coupon::get_coupon_error()

Map one of the WC_Coupon error codes to a message string.
includes/class-wc-order-refund.php: WC_Order_Refund::get_formatted_refund_amount()

Get formatted refunded amount.
packages/woocommerce-admin/src/API/Leaderboards.php: Leaderboards::get_coupons_leaderboard()

Get the data for the coupons leaderboard.
packages/woocommerce-admin/src/API/Leaderboards.php: Leaderboards::get_categories_leaderboard()

Get the data for the categories leaderboard.
packages/woocommerce-admin/src/API/Leaderboards.php: Leaderboards::get_customers_leaderboard()

Get the data for the customers leaderboard.
packages/woocommerce-admin/src/API/Leaderboards.php: Leaderboards::get_products_leaderboard()

Get the data for the products leaderboard.
Show 52 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.