wc_format_decimal( float|string $number, mixed $dp = false, bool $trim_zeros = false )

Format decimal numbers ready for DB storage.

Contents

Description Description

Sanitize, remove decimals, and optionally round + trim off zeros.

This function does not remove thousands – this should be done before passing a value to the function.

Parameters Parameters

$number

(Required) Expects either a float or a string with a decimal separator only (no thousands).

$dp

(Optional) number Number of decimal points to use, blank to use woocommerce_price_num_decimals, or false to avoid all rounding.

Default value: false

$trim_zeros

(Optional) From end of string.

Default value: false

Top ↑

Return Return

(string)

Top ↑

Source Source

File: includes/wc-formatting-functions.php 

function wc_format_decimal( $number, $dp = false, $trim_zeros = false ) {
	$locale   = localeconv();
	$decimals = array( wc_get_price_decimal_separator(), $locale['decimal_point'], $locale['mon_decimal_point'] );

	// Remove locale from string.
	if ( ! is_float( $number ) ) {
		$number = str_replace( $decimals, '.', $number );

		// Convert multiple dots to just one.
		$number = preg_replace( '/\.(?![^.]+$)|[^0-9.-]/', '', wc_clean( $number ) );
	}

	if ( false !== $dp ) {
		$dp     = intval( '' === $dp ? wc_get_price_decimals() : $dp );
		$number = number_format( floatval( $number ), $dp, '.', '' );
	} elseif ( is_float( $number ) ) {
		// DP is false - don't use number format, just return a string using whatever is given. Remove scientific notation using sprintf.
		$number = str_replace( $decimals, '.', sprintf( '%.' . wc_get_rounding_precision() . 'f', $number ) );
		// We already had a float, so trailing zeros are not needed.
		$trim_zeros = true;
	}

	if ( $trim_zeros && strstr( $number, '.' ) ) {
		$number = rtrim( rtrim( $number, '0' ), '.' );
	}

	return $number;
}

Expand full source code Collapse full source code

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
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_clean()

Clean variables using sanitize_text_field. Arrays are cleaned recursively.
includes/wc-core-functions.php: wc_get_rounding_precision()

Get rounding precision for internal WC calculations.

Top ↑

Used By Used By

Used By
Used By Description
includes/admin/class-wc-admin-post-types.php: WC_Admin_Post_Types::set_new_price()

Set the new regular or sale price if requested.
packages/woocommerce-admin/src/Notes/OrderMilestones.php: OrderMilestones::get_note_title_for_milestone()

Get the appropriate note title for a given milestone.
packages/woocommerce-blocks/src/StoreApi/Formatters/MoneyFormatter.php: MoneyFormatter::format()

Format a given value and return the result.
includes/wc-update-functions.php: wc_update_200_line_items()

Update order item line items for 2.0
includes/class-wc-cart-fees.php: WC_Cart_Fees::add_fee()

Add a fee. Fee IDs must be unique.
includes/admin/class-wc-admin-post-types.php: WC_Admin_Post_Types::quick_edit_save()

Quick edit.
includes/admin/meta-boxes/class-wc-meta-box-coupon-data.php: WC_Meta_Box_Coupon_Data::save()

Save meta box data.
includes/admin/reports/class-wc-report-sales-by-date.php: WC_Report_Sales_By_Date::query_report_data()

Get all data needed for this report and store in the class.
includes/admin/reports/class-wc-report-sales-by-date.php: WC_Report_Sales_By_Date::round_chart_totals()

Round our totals correctly.
includes/admin/reports/class-wc-report-sales-by-category.php: WC_Report_Sales_By_Category::get_main_chart()

Get the main chart.
includes/class-wc-order-item-tax.php: WC_Order_Item_Tax::set_tax_total()

Set tax total.
includes/class-wc-order-item-tax.php: WC_Order_Item_Tax::set_shipping_tax_total()

Set shipping tax total.
includes/gateways/paypal/includes/class-wc-gateway-paypal-ipn-handler.php: WC_Gateway_Paypal_IPN_Handler::payment_status_refunded()

Handle a refunded order.
includes/class-wc-structured-data.php: WC_Structured_Data::generate_product_data()

Generates Product structured data.
includes/class-wc-order.php: WC_Order::get_remaining_refund_amount()

How much money is left to refund?
includes/legacy/api/v2/class-wc-api-orders.php: WC_API_Orders::get_order_refund()

Get an order refund for the given order ID and ID
includes/legacy/api/v2/class-wc-api-orders.php: WC_API_Orders::edit_order_refund()

Edit an order refund
includes/legacy/api/v2/class-wc-api-products.php: WC_API_Products::save_product_shipping_data()

Save product shipping data
includes/legacy/api/class-wc-rest-legacy-coupons-controller.php: WC_REST_Legacy_Coupons_Controller::prepare_item_for_response()

Prepare a single coupon output for response.
includes/legacy/api/class-wc-rest-legacy-orders-controller.php: WC_REST_Legacy_Orders_Controller::prepare_item_for_response()

Prepare a single order output for response.
includes/legacy/api/v2/class-wc-api-customers.php: WC_API_Customers::get_customer()

Get the customer for the given ID
includes/legacy/api/v2/class-wc-api-orders.php: WC_API_Orders::get_order()

Get the order for the given ID
includes/legacy/api/v2/class-wc-api-coupons.php: WC_API_Coupons::get_coupon()

Get the coupon for the given ID
includes/legacy/api/v2/class-wc-api-coupons.php: WC_API_Coupons::edit_coupon()

Edit a coupon
includes/legacy/api/v2/class-wc-api-coupons.php: WC_API_Coupons::create_coupon()

Create a coupon
includes/legacy/api/v2/class-wc-api-products.php: WC_API_Products::get_product_data()

Get standard product data that applies to every product type
includes/legacy/api/v2/class-wc-api-products.php: WC_API_Products::get_variation_data()

Get an individual variation’s data
includes/legacy/api/v2/class-wc-api-reports.php: WC_API_Reports::get_sales_report()

Get the sales report
includes/legacy/abstract-wc-legacy-order.php: WC_Abstract_Legacy_Order::legacy_set_total()

Set an order total.
includes/legacy/abstract-wc-legacy-order.php: WC_Abstract_Legacy_Order::add_shipping()

Add a shipping row to the order.
includes/class-wc-cart.php: WC_Cart::get_taxes_total()

Get tax row amounts with or without compound taxes includes.
includes/class-wc-cart.php: WC_Cart::set_total()

Set cart total.
includes/class-wc-cart.php: WC_Cart::set_fee_total()

Set fee amount.
includes/class-wc-cart.php: WC_Cart::set_shipping_total()

Set shipping_total.
includes/class-wc-cart.php: WC_Cart::set_cart_contents_total()

Set cart_contents_total.
includes/class-wc-cart.php: WC_Cart::set_subtotal()

Set subtotal.
includes/class-wc-ajax.php: WC_AJAX::tax_rates_save_changes()

Handle submissions from assets/js/settings-views-html-settings-tax.js Backbone model.
includes/class-wc-ajax.php: WC_AJAX::variation_bulk_adjust_price()

Bulk action – Set Price.
includes/class-wc-ajax.php: WC_AJAX::refund_line_items()

Handle a refund via the edit order screen.
includes/data-stores/class-wc-customer-data-store.php: WC_Customer_Data_Store::get_total_spent()

Return how much money this customer has spent.
includes/data-stores/class-wc-product-data-store-cpt.php: WC_Product_Data_Store_CPT::get_data_for_lookup_table()

Get data to save to a lookup table.
includes/data-stores/class-wc-product-variable-data-store-cpt.php: WC_Product_Variable_Data_Store_CPT::read_price_data()

Get an array of all sale and regular prices from all variations. This is used for example when displaying the price range at variable product level or seeing if the variable product is on sale.
includes/class-wc-order-item-shipping.php: WC_Order_Item_Shipping::set_total_tax()

Set total tax.
includes/class-wc-order-item-shipping.php: WC_Order_Item_Shipping::set_total()

Set total.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::set_total_tax()

Sets order tax (sum of cart and shipping tax). Used internally only.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::set_total()

Set total.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::set_discount_total()

Set discount_total.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::set_discount_tax()

Set discount_tax.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::set_shipping_total()

Set shipping_total.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::set_shipping_tax()

Set shipping_tax.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::set_cart_tax()

Set cart tax.
includes/abstracts/abstract-wc-settings-api.php: WC_Settings_API::validate_decimal_field()

Validate Decimal Field.
includes/abstracts/abstract-wc-settings-api.php: WC_Settings_API::validate_price_field()

Validate Price Field.
includes/abstracts/abstract-wc-product.php: WC_Product::set_average_rating()

Set average rating. Read only.
includes/abstracts/abstract-wc-product.php: WC_Product::set_height()

Set the product height.
includes/abstracts/abstract-wc-product.php: WC_Product::set_weight()

Set the product’s weight.
includes/abstracts/abstract-wc-product.php: WC_Product::set_length()

Set the product length.
includes/abstracts/abstract-wc-product.php: WC_Product::set_width()

Set the product width.
includes/abstracts/abstract-wc-product.php: WC_Product::set_price()

Set the product’s active price.
includes/abstracts/abstract-wc-product.php: WC_Product::set_regular_price()

Set the product’s regular price.
includes/abstracts/abstract-wc-product.php: WC_Product::set_sale_price()

Set the product’s sale price.
includes/abstracts/abstract-wc-shipping-method.php: WC_Shipping_Method::add_rate()

Add a shipping rate. If taxes are not set they will be calculated based on cost.
includes/class-wc-order-item-product.php: WC_Order_Item_Product::set_total_tax()

Line total tax (after discounts).
includes/class-wc-order-item-product.php: WC_Order_Item_Product::set_subtotal()

Line subtotal (before discounts).
includes/class-wc-order-item-product.php: WC_Order_Item_Product::set_total()

Line total (after discounts).
includes/class-wc-order-item-product.php: WC_Order_Item_Product::set_subtotal_tax()

Line subtotal tax (before discounts).
includes/class-wc-checkout.php: WC_Checkout::create_order_shipping_lines()

Add shipping lines to the order.
includes/wc-deprecated-functions.php: _wc_save_product_price()

Save product price.
includes/wc-deprecated-functions.php: woocommerce_format_decimal()
includes/wc-deprecated-functions.php: woocommerce_format_total()

Formal total costs – format to the number of decimal places for the base currency.
includes/wc-order-functions.php: wc_order_fully_refunded()

When refunding an order, create a refund line item if the partial refunds do not match order total.
includes/class-wc-coupon.php: WC_Coupon::set_minimum_amount()

Set the minimum spend amount.
includes/class-wc-coupon.php: WC_Coupon::set_maximum_amount()

Set the maximum spend amount.
includes/class-wc-coupon.php: WC_Coupon::set_amount()

Set amount.
includes/class-wc-coupon.php: WC_Coupon::get_amount()

Get coupon amount.
includes/class-wc-order-refund.php: WC_Order_Refund::set_amount()

Set refunded amount.
includes/class-wc-order-item-coupon.php: WC_Order_Item_Coupon::set_discount()

Set discount amount.
includes/class-wc-order-item-coupon.php: WC_Order_Item_Coupon::set_discount_tax()

Set discounted tax amount.
includes/class-wc-order-item-fee.php: WC_Order_Item_Fee::set_amount()

Set fee amount.
includes/class-wc-order-item-fee.php: WC_Order_Item_Fee::set_total()

Set total.
includes/class-wc-order-item-fee.php: WC_Order_Item_Fee::set_total_tax()

Set total tax.
packages/woocommerce-admin/src/API/Orders.php: Orders::get_formatted_item_data()

Get formatted item data.
includes/rest-api/Controllers/Version1/class-wc-rest-coupons-v1-controller.php: WC_REST_Coupons_V1_Controller::prepare_item_for_response()

Prepare a single coupon output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-orders-v1-controller.php: WC_REST_Orders_V1_Controller::prepare_item_for_response()

Prepare a single order output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-report-sales-v1-controller.php: WC_REST_Report_Sales_V1_Controller::prepare_item_for_response()

Prepare a report sales object for serialization.
includes/rest-api/Controllers/Version1/class-wc-rest-order-refunds-v1-controller.php: WC_REST_Order_Refunds_V1_Controller::prepare_item_for_response()

Prepare a single order refund output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-products-v1-controller.php: WC_REST_Products_V1_Controller::get_product_data()

Get product data.
includes/rest-api/Controllers/Version2/class-wc-rest-coupons-v2-controller.php: WC_REST_Coupons_V2_Controller::get_formatted_item_data()

Get formatted item data.
includes/rest-api/Controllers/Version2/class-wc-rest-order-refunds-v2-controller.php: WC_REST_Order_Refunds_V2_Controller::get_formatted_item_data()

Get formatted item data.
includes/rest-api/Controllers/Version2/class-wc-rest-products-v2-controller.php: WC_REST_Products_V2_Controller::get_product_data()

Get product data.
includes/rest-api/Controllers/Version2/class-wc-rest-orders-v2-controller.php: WC_REST_Orders_V2_Controller::get_order_item_data()

Expands an order item to get its data.
includes/rest-api/Controllers/Version2/class-wc-rest-orders-v2-controller.php: WC_REST_Orders_V2_Controller::get_formatted_item_data()

Get formatted item data.
Show 87 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.