NumberFormatter::formatCurrency

    numfmt_format_currency

    (PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

    NumberFormatter::formatCurrency -- numfmt_format_currency — Format a currency value

    Description

    Object-oriented style

    public NumberFormatter::formatCurrency(float $amount, string $currency): string|false

    Procedural style

    numfmt_format_currency(NumberFormatter $formatter, float $amount, string $currency): string|false

    Format the currency value according to the formatter rules.

    Parameters

    formatter

    NumberFormatter object.

    amount

    The numeric currency value.

    currency

    The 3-letter ISO 4217 currency code indicating the currency to use.

    Return Values

    String representing the formatted currency value, or false on failure.

    Examples

    Example #1 numfmt_format_currency() example

    <?php
    $fmt     = numfmt_create( 'de_DE', NumberFormatter::CURRENCY );
    echo     numfmt_format_currency($fmt, 1234567.891234567890000, "EUR")."\n";
    echo     numfmt_format_currency($fmt, 1234567.891234567890000, "RUR")."\n";
    $fmt = numfmt_create( 'ru_RU', NumberFormatter::CURRENCY );
    echo     numfmt_format_currency($fmt, 1234567.891234567890000, "EUR")."\n";
    echo     numfmt_format_currency($fmt, 1234567.891234567890000, "RUR")."\n";
    ?>

    Example #2 OO example

    <?php
    $fmt     = new NumberFormatter( 'de_DE', NumberFormatter::CURRENCY );
    echo     $fmt->formatCurrency(1234567.891234567890000, "EUR")."\n";
    echo     $fmt->formatCurrency(1234567.891234567890000, "RUR")."\n";
    $fmt = new NumberFormatter( 'ru_RU', NumberFormatter::CURRENCY );
    echo     $fmt->formatCurrency(1234567.891234567890000, "EUR")."\n";
    echo     $fmt->formatCurrency(1234567.891234567890000, "RUR")."\n";
    ?>

    The above example will output:

    1.234.567,89 €
1.234.567,89 RUR
1 234 567,89€
1 234 567,89р.

    Notes

    Note:

    Formats achievable by this method of formatting cannot fully use the possibilities of underlying ICU library, such as to format currency with narrow currency symbol.

    To fully utilize them use msgfmt_format_message().

    See Also

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 8 notes

    up
    48
    Ruben
    11 years ago
    While this function accepts floats for currency (in order to display cents), you should (for applications where this is critical) never store or handle money using floats, as rounding errors may occur. Work with integers (or a BigInt class if integers aren't large enough) internally instead, where the integer represents the total number of cents. An alternative (especially if you need more precision than cents) is using the BC (Binary Calculator) Math module, that handles arbitrary precision numbers with 100% accuracy.
    up
    29
    martin t holzhauer dohd eu
    10 years ago
    When you want to format currency's without sub units and the currency is not the one used by the given locale you need to set the currency code before as TextAttribute _BEFORE_ setting the NumberFormatter::FRACTION_DIGITS

    <?php
    $fmt     = new NumberFormatter('en_US', NumberFormatter::CURRENCY);
    $fmt->setTextAttribute(NumberFormatter::CURRENCY_CODE, 'EUR');
    $fmt->setAttribute(NumberFormatter::FRACTION_DIGITS, 0);
    $fmt->formatCurrency(100, 'EUR');
    ?>
    up
    10
    mail at cebe dot cc
    9 years ago
    The note about different formatting[1] actually does not depend on the PHP version but on the version of the icu library[2] that PHP is compiled against because this library has a database with formatting rules for the different locales.

    [1]: http://php.net/manual/en/numberformatter.formatcurrency.php#116610
    [2]: http://site.icu-project.org/
    up
    5
    Anonymous
    6 years ago
    formatCurrency() does not follow international standard for currency decimal, published here : https://www.currency-iso.org/en/home/tables/table-a1.html.

    To define decimal I found that we need to use format() function after setting some NumberFormat attributes.

    For example "COP" (Colombian peso) if defined to use 2 decimals, but NumberFormat::formatCurrency() use 0 decimal for this currency (I do not know why!).

    Here is the code I use :

    $fmt = new \NumberFormatter( 'fr', \NumberFormatter::CURRENCY);
    $fmt->setTextAttribute( $fmt::CURRENCY_CODE, 'COP' );
    $fmt->setAttribute( $fmt::FRACTION_DIGITS, 2 );
    $numberString = $fmt->format( 1234.56 );

    The output is: 1 234,56 $CO

    If locale change to 'en' then the output is : COP1,234.56
    up
    4
    andrewfenn at gmail dot com
    7 years ago
    Currency symbols seem to have spurious support.

    Take for example the Thai Baht symbol.. ฿ which doesn't seem supported in the Thai locale, but is in other locales such as Chinese Simplified..

    <?php
    $fmt     = new NumberFormatter('th_TH', NumberFormatter::CURRENCY);
    echo     $fmt->formatCurrency(100, 'THB');
    // Outputs: THB 100

    $fmt = new NumberFormatter('zh_Hans', NumberFormatter::CURRENCY);
    echo     $fmt->formatCurrency(100, 'THB');
    // Outputs: ฿ 100
    ?>
    up
    4
    Tyler Crompton
    9 years ago
    This had me scratching my head. When working with certain English locales (e.g. "en_US" and "en_CA" among others but certainly not all), it is important to note that negative numbers are formatted differently between PHP 5.5 and PHP 5.6.

    Code:

    <?php

    $formatter     = new NumberFormatter('en_US', NumberFormatter::CURRENCY);
    echo     $formatter->formatCurrency(-0.99, 'USD'), PHP_EOL;

    $formatter = new NumberFormatter('en_CA', NumberFormatter::CURRENCY);
    echo     $formatter->formatCurrency(-0.99, 'USD'), PHP_EOL;

    ?>

    Output from PHP 5.5:

    -$0.99
    -US$0.99

    Output from PHP 5.6:

    ($0.99)
    (US$0.99)
    up
    3
    Benoit Borrel
    8 years ago
    When setting the pattern, don't forget that space character between currency symbol and number (either as prefix or suffix) should not be breakable (like &nbsp; for HTML). For example, in UTF-8 you should use the no-break-space character ("\xC2\xA0"):
    <?php
    $fmt     = new NumberFormatter('en_US', NumberFormatter::CURRENCY);
    $fmt->setPattern(str_replace('¤#',"¤\xC2\xA0#", $fmt->getPattern()));
    ?>
    up
    0
    Patanjali
    4 years ago
    This function is typically over a 1000 times slower on the first run in a php session compared to subsequent runs, and that is using a newly created formatter each time.

    Timings for the first run have been from 60ms to 195ms, whereas subsequent runs are well under 100us.

    For comparison, creating the formatter takes about 100us.
    ＋add a note
    To Top