Localize currency using encapsulated NumberFormatter functions

currency_format.php

<?php
/**
 * Localize currency using encapsulated NumberFormatter functions
 *
 * @param float $amount
 * @param array $kwargs
 * @link https://www.php.net/manual/en/numberformatter.formatcurrency.php
 * @link https://www.php.net/manual/en/numberformatter.create.php
 * @link https://www.php.net/manual/en/class.locale.php
 * @return string|false
 */
 function currency_format($amount, array $kwargs = []) {
    extract($kwargs + [
        'locale'  => substr(Locale::getDefault(), 0, 5) ?: NULL,
        'pattern' => NULL,
    ]);
    $fmt = numfmt_create($locale, NumberFormatter::CURRENCY, $pattern);
    $symbol = numfmt_get_symbol($fmt, NumberFormatter::INTL_CURRENCY_SYMBOL);
    return numfmt_format_currency($fmt, $amount, $symbol);
}

numfmt_create() arguments

• https://www.php.net/manual/en/numberformatter.create.php

numfmt_create(string $locale, int $style, ?string $pattern = null): ?NumberFormatter

$locale

• https://www.php.net/manual/en/function.setlocale

If NULL, it will lookup its default value in this order:

1. ini_get('intl.default_locale')
2. setlocale(LC_ALL, '0');
3. $LANG value from the set locale of the operating system.

$style

• https://www.php.net/manual/en/class.numberformatter.php#intl.numberformatter-constants.unumberformatstyle

• For currency, it's NumberFormatter::CURRENCY.

• For PHP version 7.4.1, there is NumberFormatter::CURRENCY_ACCOUNTING to format amounts with parentheses.

$pattern

• https://unicode.org/reports/tr35/tr35-numbers.html#table-number-pattern-character-definitions

• If not NULL, it will override the style argument.

• If NULL, it will defer to the style argument.