php8.5
Home/ Manual/ strings / functions/ localeconv

localeconv

PHP function Edit on GitHub ✎

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

Get numeric formatting information

Description

localeconv(): array

Returns an associative array containing localized numeric and monetary formatting information.

Parameters Parameters

Return Values

localeconv() returns data based upon the current locale as set by setlocale(). The associative array that is returned contains the following fields:

Array elementDescription
decimal_pointDecimal point character
thousands_sepThousands separator
groupingArray containing numeric groupings
int_curr_symbolInternational currency symbol (i.e. USD)
currency_symbolLocal currency symbol (i.e. $)
mon_decimal_pointMonetary decimal point character
mon_thousands_sepMonetary thousands separator
mon_groupingArray containing monetary groupings
positive_signSign for positive values
negative_signSign for negative values
int_frac_digitsInternational fractional digits
frac_digitsLocal fractional digits
p_cs_precedes1 if currency_symbol precedes a positive value, 0 if it succeeds one
p_sep_by_space1 if a space separates currency_symbol from a positive value, 0 otherwise
n_cs_precedes1 if currency_symbol precedes a negative value, 0 if it succeeds one
n_sep_by_space1 if a space separates currency_symbol from a negative value, 0 otherwise
p_sign_posn0 - Parentheses surround the quantity and currency_symbol1 - The sign string precedes the quantity and currency_symbol2 - The sign string succeeds the quantity and currency_symbol3 - The sign string immediately precedes the currency_symbol4 - The sign string immediately succeeds the currency_symbol
n_sign_posn0 - Parentheses surround the quantity and currency_symbol1 - The sign string precedes the quantity and currency_symbol2 - The sign string succeeds the quantity and currency_symbol3 - The sign string immediately precedes the currency_symbol4 - The sign string immediately succeeds the currency_symbol

The p_sign_posn and n_sign_posn contain a string of formatting options. Each number represents one of the above listed conditions.

The grouping fields contain arrays that define the way numbers should be grouped. For example, the monetary grouping field for the nl_NL locale (in UTF-8 mode with the euro sign), would contain a 2 item array with the values 3 and 3. The higher the index in the array, the farther left the grouping is. If an array element is equal to CHAR_MAX, no further grouping is done. If an array element is equal to 0, the previous element should be used.

Examples

localeconv() example

php
<?php
if (false !== setlocale(LC_ALL, 'nl_NL.UTF-8@euro')) {
    $locale_info = localeconv();
    print_r($locale_info);
}
?>

The above example will output:

output
Array
(
    [decimal_point] => .
    [thousands_sep] =>
    [int_curr_symbol] => EUR
    [currency_symbol] => €
    [mon_decimal_point] => ,
    [mon_thousands_sep] =>
    [positive_sign] =>
    [negative_sign] => -
    [int_frac_digits] => 2
    [frac_digits] => 2
    [p_cs_precedes] => 1
    [p_sep_by_space] => 1
    [n_cs_precedes] => 1
    [n_sep_by_space] => 1
    [p_sign_posn] => 1
    [n_sign_posn] => 2
    [grouping] => Array
        (
        )

    [mon_grouping] => Array
        (
            [0] => 3
            [1] => 3
        )

)

See Also

Source: reference/strings/functions/localeconv.xml · from the official PHP manual (php/doc-en)