<!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>Finds whether a variable is a number or a numeric string</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.is-null.html">is_null</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.is-object.html">is_object</a></div>
<div class="up"><a href="ref.var.html">Variable handling Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.is-numeric" class="refentry">
<div class="refnamediv">
<h1 class="refname">is_numeric</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">is_numeric</span> — <span class="dc-title">
Finds whether a variable is a number or a numeric string
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.is-numeric-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>is_numeric</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$var</code></span>
)</div>
<p class="para rdfs-comment">
Finds whether the given variable is numeric. Numeric strings consist of optional
sign, any number of digits, optional decimal part and optional exponential part.
Thus <em>+0123.45e6</em> is a valid numeric value. Hexadecimal (e.g.
<em>0xf4c3b00c</em>), Binary (e.g. <em>0b10100111001</em>),
Octal (e.g. <em>0777</em>) notation is allowed too but only without
sign, decimal and exponential part.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.is-numeric-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">var</code></em></span>
<dd>
<p class="para">
The variable being evaluated.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.is-numeric-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if <em><code class="parameter">var</code></em> is a number or a numeric
string, <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.is-numeric-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5262">
<p><strong>Example #1 <span class="function"><strong>is_numeric()</strong></span> examples</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$tests </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">"42"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">1337</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0x539</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">02471</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0b10100111001</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">1337e0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"not numeric"</span><span style="color: #007700">,<br /> array(),<br /> </span><span style="color: #0000BB">9.1<br /></span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$tests </span><span style="color: #007700">as </span><span style="color: #0000BB">$element</span><span style="color: #007700">) {<br /> if (</span><span style="color: #0000BB">is_numeric</span><span style="color: #007700">(</span><span style="color: #0000BB">$element</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"'</span><span style="color: #007700">{</span><span style="color: #0000BB">$element</span><span style="color: #007700">}</span><span style="color: #DD0000">' is numeric"</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /> } else {<br /> echo </span><span style="color: #DD0000">"'</span><span style="color: #007700">{</span><span style="color: #0000BB">$element</span><span style="color: #007700">}</span><span style="color: #DD0000">' is NOT numeric"</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /> }<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
'42' is numeric
'1337' is numeric
'1337' is numeric
'1337' is numeric
'1337' is numeric
'1337' is numeric
'not numeric' is NOT numeric
'Array' is NOT numeric
'9.1' is numeric
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.is-numeric-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ctype-digit.html" class="function" rel="rdfs-seeAlso">ctype_digit()</a> - Check for numeric character(s)</span></li>
<li class="member"> <span class="function"><a href="function.is-bool.html" class="function" rel="rdfs-seeAlso">is_bool()</a> - Finds out whether a variable is a boolean</span></li>
<li class="member"> <span class="function"><a href="function.is-null.html" class="function" rel="rdfs-seeAlso">is_null()</a> - Finds whether a variable is NULL</span></li>
<li class="member"> <span class="function"><a href="function.is-float.html" class="function" rel="rdfs-seeAlso">is_float()</a> - Finds whether the type of a variable is float</span></li>
<li class="member"> <span class="function"><a href="function.is-int.html" class="function" rel="rdfs-seeAlso">is_int()</a> - Find whether the type of a variable is integer</span></li>
<li class="member"> <span class="function"><a href="function.is-string.html" class="function" rel="rdfs-seeAlso">is_string()</a> - Find whether the type of a variable is string</span></li>
<li class="member"> <span class="function"><a href="function.is-object.html" class="function" rel="rdfs-seeAlso">is_object()</a> - Finds whether a variable is an object</span></li>
<li class="member"> <span class="function"><a href="function.is-array.html" class="function" rel="rdfs-seeAlso">is_array()</a> - Finds whether a variable is an array</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.is-null.html">is_null</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.is-object.html">is_object</a></div>
<div class="up"><a href="ref.var.html">Variable handling Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
