NUMBER_FORMAT(3) 1 NUMBER_FORMAT(3)
number_format - Format a number with grouped thousands
SYNOPSIS
string number_format (float $number, [int $decimals])
DESCRIPTION
string number_format (float $number, int $decimals, string $dec_point = ".", string $thousands_sep = ",")
This function accepts either one, two, or four parameters (not three):
If only one parameter is given, $number will be formatted without decimals, but with a comma (",") between every group of thousands.
If two parameters are given, $number will be formatted with $decimals decimals with a dot (".") in front, and a comma (",") between every
group of thousands.
If all four parameters are given, $number will be formatted with $decimals decimals, $dec_point instead of a dot (".") before the decimals
and $thousands_sep instead of a comma (",") between every group of thousands.
PARAMETERS
o $number
- The number being formatted.
o $decimals
- Sets the number of decimal points.
o $dec_point
- Sets the separator for the decimal point.
o $thousands_sep
- Sets the thousands separator.
RETURN VALUES
A formatted version of $number.
CHANGELOG
+--------+---------------------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+---------------------------------------------------+
| 5.4.0 | |
| | |
| | This function now supports multiple bytes in |
| | $dec_point and $thousands_sep. Only the first |
| | byte of each separator was used in older ver- |
| | sions. |
| | |
+--------+---------------------------------------------------+
EXAMPLES
Example #1
number_format(3) Example
For instance, French notation usually use two decimals, comma (',') as decimal separator, and space (' ') as thousand separator.
This is achieved with this line :
<?php
$number = 1234.56;
// english notation (default)
$english_format_number = number_format($number);
// 1,235
// French notation
$nombre_format_francais = number_format($number, 2, ',', ' ');
// 1 234,56
$number = 1234.5678;
// english notation without thousands separator
$english_format_number = number_format($number, 2, '.', '');
// 1234.57
?>
SEE ALSO
money_format(3), sprintf(3), printf(3), sscanf(3).
PHP Documentation Group NUMBER_FORMAT(3)