number_format
(PHP 4, PHP 5, PHP 7)
number_format — Format a number with grouped thousands
Description
$number
[, int $decimals = 0
] ) : string$number
, int $decimals = 0
, string $dec_point = "."
, string $thousands_sep = ","
) : stringThis 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
-
number -
The number being formatted.
-
decimals -
Sets the number of decimal points.
-
dec_point -
Sets the separator for the decimal point.
-
thousands_sep -
Sets the thousands separator.
Changelog
| Version | Description |
|---|---|
| 7.2.0 |
number_format() was changed to not being able to return
-0, previously -0 could be returned
for cases like where number would be -0.01.
|
| 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 versions.
|
Examples
Example #1 number_format() Example
For instance, French notation usually use two decimals, comma (',') as decimal separator, and space (' ') as thousand separator. The following example demonstrates various ways to format a number:
<?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() - Formats a number as a currency string
- sprintf() - Return a formatted string
- printf() - Output a formatted string
- sscanf() - Parses input from a string according to a format
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.number-format.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
