Automattic\WooCommerce\StoreApi\Formatters

MoneyFormatter::format │ public │ WC 1.0

Format a given price value and return the result as a string without decimals.

Method of the class: MoneyFormatter{}

No Hooks.

Returns

String.

Usage

$MoneyFormatter = new MoneyFormatter();
$MoneyFormatter->format( $value, $options );

$value(int|float|string) (required)

Value to format. Int is allowed, as it may also represent a valid price.

$options(array)

Options that influence the formatting.
Default: []

MoneyFormatter::format() MoneyFormatter::format code ^{WC 10.3.6}

public function format( $value, array $options = [] ) {

	if ( ! is_int( $value ) && ! is_string( $value ) && ! is_float( $value ) ) {
		wc_doing_it_wrong(
			__FUNCTION__,
			'Function expects a $value arg of type INT, STRING or FLOAT.',
			'9.2'
		);

		return '';
	}

	$options = wp_parse_args(
		$options,
		[
			'decimals'      => wc_get_price_decimals(),
			'rounding_mode' => PHP_ROUND_HALF_UP,
		]
	);

	// Ensure rounding mode is valid.
	$rounding_modes           = [ PHP_ROUND_HALF_UP, PHP_ROUND_HALF_DOWN, PHP_ROUND_HALF_EVEN, PHP_ROUND_HALF_ODD ];
	$options['rounding_mode'] = absint( $options['rounding_mode'] );
	if ( ! in_array( $options['rounding_mode'], $rounding_modes, true ) ) {
		$options['rounding_mode'] = PHP_ROUND_HALF_UP;
	}

	$value = floatval( $value );

	// Remove the price decimal points for rounding purposes.
	$value = $value * pow( 10, absint( $options['decimals'] ) );
	$value = round( $value, 0, $options['rounding_mode'] );

	// This ensures returning the value as a string without decimal points ready for price parsing.
	return wc_format_decimal( $value, 0, true );
}