PHP String number_format() Function

---

---

The PHP String number_format() function is used to format a number with grouped thousands and decimal digits can be rounded using the half-up rule. It returns the formatted number if it successfully executed and displays E_WARNING if it fails.

Syntax

Below is the syntax of the PHP String number_format() function −

string number_format(
   float $num,
   int $decimals = 0,
   ?string $decimal_separator = ".",
   ?string $thousands_separator = ","
)

Parameters

Here are the parameters of the number_format() function −

• $num − It contains the information about number to be formatted.

• $decimals − It specifies who many numbers are to be set.

• $decimal_separator − It specifies what string to use for decimal point.

• $thousands_separator − It specifies what string to use to separate the thousands of strings.

Return Value

The number_format() function returns formatted number if successful, and E_WARNING if unsuccessful.

PHP Version

First introduced in core PHP 4, the number_format() function continues to function easily in PHP 5, PHP 7, and PHP 8.

Example 1

Here we will show you the usage of PHP String number_format() function to produce a number using the number of decimals (0) and the default separators (dot for decimals, comma for thousands).

<?php
   // Define the number here
   $num = 1234567.89;

   // Produce a number format and print it
   echo number_format($num); 
?>

Output

Here is the outcome of the following code −

1,234,568

Example 2

In the below PHP code we use the number_format() function and format the number with 2 decimal places.

<?php
   // Define the number here
   $num = 1234567.89;

   // Format the number with 2 decimal places
   echo number_format($num, 2); 
?> 

Output

This will generate the below output −

1,234,567.89

Example 3

Now the below code uses a custom decimal separator (",") and thousands separator (".") as the parameter of number_format() function.

<?php
   // Define the number here
   $num = 1234567.89;

   // Use a custom decimal separator
   echo number_format($num, 2, ',', '.'); 
?> 

Output

This will create the below output −

1.234.567,89

Example 4

In the following example, we are using the number_format() function to format a negative number with custom separators and decimal places.

<?php
   // Define a negative number
   $num = -9876543.21;

   // Format the number and print the value
   echo number_format($num, 3, '.', ' ');
?> 

Output

Following is the output of the above code −

-9 876 543.210