<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Format a number with grouped thousands</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.nl2br.html">nl2br</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ord.html">ord</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.number-format" class="refentry">
<div class="refnamediv">
<h1 class="refname">number_format</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">number_format</span> — <span class="dc-title">Format a number with grouped thousands</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.number-format-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>number_format</strong></span>
( <span class="methodparam"><span class="type">float</span> <code class="parameter">$number</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$decimals</code><span class="initializer"> = 0</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>number_format</strong></span>
( <span class="methodparam"><span class="type">float</span> <code class="parameter">$number</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$decimals</code><span class="initializer"> = 0</span></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dec_point</code><span class="initializer"> = '.'</span></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$thousands_sep</code><span class="initializer"> = ','</span></span>
)</div>
<p class="para rdfs-comment">
This function accepts either one, two, or four parameters (not three):
</p>
<p class="para">
If only one parameter is given,
<em><code class="parameter">number</code></em> will be formatted without decimals,
but with a comma (",") between every group of thousands.
</p>
<p class="para">
If two parameters are given, <em><code class="parameter">number</code></em> will
be formatted with <em><code class="parameter">decimals</code></em> decimals with a
dot (".") in front, and a comma (",") between every group of
thousands.
</p>
<p class="para">
If all four parameters are given, <em><code class="parameter">number</code></em>
will be formatted with <em><code class="parameter">decimals</code></em> decimals,
<em><code class="parameter">dec_point</code></em> instead of a dot (".") before
the decimals and <em><code class="parameter">thousands_sep</code></em> instead of
a comma (",") between every group of thousands.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.number-format-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">number</code></em></span>
<dd>
<p class="para">
The number being formatted.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">decimals</code></em></span>
<dd>
<p class="para">
Sets the number of decimal points.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">dec_point</code></em></span>
<dd>
<p class="para">
Sets the separator for the decimal point.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">thousands_sep</code></em></span>
<dd>
<p class="para">
Sets the thousands separator.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.number-format-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A formatted version of <em><code class="parameter">number</code></em>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.number-format-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.4.0</td>
<td>
This function now supports multiple bytes in
<em><code class="parameter">dec_point</code></em> and
<em><code class="parameter">thousands_sep</code></em>. Only the first byte of each
separator was used in older versions.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.number-format-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4853">
<p><strong>Example #1 <span class="function"><strong>number_format()</strong></span> Example</strong></p>
<div class="example-contents"><p>
For instance, French notation usually use two decimals,
comma (',') as decimal separator, and space (' ') as
thousand separator. This is achieved with this line :
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$number </span><span style="color: #007700">= </span><span style="color: #0000BB">1234.56</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// english notation (default)<br /></span><span style="color: #0000BB">$english_format_number </span><span style="color: #007700">= </span><span style="color: #0000BB">number_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$number</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// 1,235<br /><br />// French notation<br /></span><span style="color: #0000BB">$nombre_format_francais </span><span style="color: #007700">= </span><span style="color: #0000BB">number_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$number</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #DD0000">','</span><span style="color: #007700">, </span><span style="color: #DD0000">' '</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// 1 234,56<br /><br /></span><span style="color: #0000BB">$number </span><span style="color: #007700">= </span><span style="color: #0000BB">1234.5678</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// english notation without thousands separator<br /></span><span style="color: #0000BB">$english_format_number </span><span style="color: #007700">= </span><span style="color: #0000BB">number_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$number</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #DD0000">'.'</span><span style="color: #007700">, </span><span style="color: #DD0000">''</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// 1234.57<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.number-format-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.money-format.html" class="function" rel="rdfs-seeAlso">money_format()</a> - Formats a number as a currency string</span></li>
<li class="member"> <span class="function"><a href="function.sprintf.html" class="function" rel="rdfs-seeAlso">sprintf()</a> - Return a formatted string</span></li>
<li class="member"> <span class="function"><a href="function.printf.html" class="function" rel="rdfs-seeAlso">printf()</a> - Output a formatted string</span></li>
<li class="member"> <span class="function"><a href="function.sscanf.html" class="function" rel="rdfs-seeAlso">sscanf()</a> - Parses input from a string according to a format</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.nl2br.html">nl2br</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ord.html">ord</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
