Automattic\WooCommerce\StoreApi\Formatters

CurrencyFormatter::format() │ public │ WC 1.0

Format a given value and return the result.

Method of the class: CurrencyFormatter{}

No Hooks.

Return

Array.

Usage

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

$value(array) (required)

Value to format.

$options(array)

Options that influence the formatting.
Default: []

CurrencyFormatter::format() CurrencyFormatter::format code ^{WC 7.7.0}

public function format( $value, array $options = [] ) {
	$position = get_option( 'woocommerce_currency_pos' );
	$symbol   = html_entity_decode( get_woocommerce_currency_symbol() );
	$prefix   = '';
	$suffix   = '';

	switch ( $position ) {
		case 'left_space':
			$prefix = $symbol . ' ';
			break;
		case 'left':
			$prefix = $symbol;
			break;
		case 'right_space':
			$suffix = ' ' . $symbol;
			break;
		case 'right':
			$suffix = $symbol;
			break;
	}

	return array_merge(
		(array) $value,
		[
			'currency_code'               => get_woocommerce_currency(),
			'currency_symbol'             => $symbol,
			'currency_minor_unit'         => wc_get_price_decimals(),
			'currency_decimal_separator'  => wc_get_price_decimal_separator(),
			'currency_thousand_separator' => wc_get_price_thousand_separator(),
			'currency_prefix'             => $prefix,
			'currency_suffix'             => $suffix,
		]
	);
}