<!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>Filters a variable with a specified filter</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.filter-var-array.html">filter_var_array</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.funchand.html">Function Handling</a></div>
<div class="up"><a href="ref.filter.html">Filter Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.filter-var" class="refentry">
<div class="refnamediv">
<h1 class="refname">filter_var</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">filter_var</span> — <span class="dc-title">Filters a variable with a specified filter</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.filter-var-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>filter_var</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">$variable</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$filter</code><span class="initializer"> = FILTER_DEFAULT</span></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">$options</code></span>
]] )</div>
</div>
<div class="refsect1 parameters" id="refsect1-function.filter-var-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">variable</code></em></span>
<dd>
<p class="para">
Value to filter.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">filter</code></em></span>
<dd>
<p class="para">
The ID of the filter to apply. The <a href="filter.filters.html" class="xref">Types of filters</a>
manual page lists the available filters.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">options</code></em></span>
<dd>
<p class="para">
Associative array of options or bitwise disjunction of flags. If filter
accepts options, flags can be provided in "flags" field of array. For
the "callback" filter, <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> type should be passed. The
callback must accept one argument, the value to be filtered, and return
the value after filtering/sanitizing it.
</p>
<p class="para">
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// for filters that accept options, use this format<br /></span><span style="color: #0000BB">$options </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'options' </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">'default' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">, </span><span style="color: #FF8000">// value to return if the filter fails<br /> // other options here<br /> </span><span style="color: #DD0000">'min_range' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0<br /> </span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'flags' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_FLAG_ALLOW_OCTAL</span><span style="color: #007700">,<br />);<br /></span><span style="color: #0000BB">$var </span><span style="color: #007700">= </span><span style="color: #0000BB">filter_var</span><span style="color: #007700">(</span><span style="color: #DD0000">'0755'</span><span style="color: #007700">, </span><span style="color: #0000BB">FILTER_VALIDATE_INT</span><span style="color: #007700">, </span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// for filter that only accept flags, you can pass them directly<br /></span><span style="color: #0000BB">$var </span><span style="color: #007700">= </span><span style="color: #0000BB">filter_var</span><span style="color: #007700">(</span><span style="color: #DD0000">'oops'</span><span style="color: #007700">, </span><span style="color: #0000BB">FILTER_VALIDATE_BOOLEAN</span><span style="color: #007700">, </span><span style="color: #0000BB">FILTER_NULL_ON_FAILURE</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// for filter that only accept flags, you can also pass as an array<br /></span><span style="color: #0000BB">$var </span><span style="color: #007700">= </span><span style="color: #0000BB">filter_var</span><span style="color: #007700">(</span><span style="color: #DD0000">'oops'</span><span style="color: #007700">, </span><span style="color: #0000BB">FILTER_VALIDATE_BOOLEAN</span><span style="color: #007700">,<br /> array(</span><span style="color: #DD0000">'flags' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_NULL_ON_FAILURE</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// callback validate filter<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">foo</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #FF8000">// Expected format: Surname, GivenNames<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">strpos</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">, </span><span style="color: #DD0000">", "</span><span style="color: #007700">) === </span><span style="color: #0000BB">false</span><span style="color: #007700">) return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /> list(</span><span style="color: #0000BB">$surname</span><span style="color: #007700">, </span><span style="color: #0000BB">$givennames</span><span style="color: #007700">) = </span><span style="color: #0000BB">explode</span><span style="color: #007700">(</span><span style="color: #DD0000">", "</span><span style="color: #007700">, </span><span style="color: #0000BB">$value</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$empty </span><span style="color: #007700">= (empty(</span><span style="color: #0000BB">$surname</span><span style="color: #007700">) || empty(</span><span style="color: #0000BB">$givennames</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">$notstrings </span><span style="color: #007700">= (!</span><span style="color: #0000BB">is_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$surname</span><span style="color: #007700">) || !</span><span style="color: #0000BB">is_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$givennames</span><span style="color: #007700">));<br /> if (</span><span style="color: #0000BB">$empty </span><span style="color: #007700">|| </span><span style="color: #0000BB">$notstrings</span><span style="color: #007700">) {<br /> return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /> } else {<br /> return </span><span style="color: #0000BB">$value</span><span style="color: #007700">;<br /> }<br />}<br /></span><span style="color: #0000BB">$var </span><span style="color: #007700">= </span><span style="color: #0000BB">filter_var</span><span style="color: #007700">(</span><span style="color: #DD0000">'Doe, Jane Sue'</span><span style="color: #007700">, </span><span style="color: #0000BB">FILTER_CALLBACK</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'options' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'foo'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.filter-var-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the filtered data, or <strong><code>FALSE</code></strong> if the filter fails.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.filter-var-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5094">
<p><strong>Example #1 A <span class="function"><strong>filter_var()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">filter_var</span><span style="color: #007700">(</span><span style="color: #DD0000">'bob@example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">FILTER_VALIDATE_EMAIL</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">filter_var</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">FILTER_VALIDATE_URL</span><span style="color: #007700">, </span><span style="color: #0000BB">FILTER_FLAG_PATH_REQUIRED</span><span style="color: #007700">));<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>
string(15) "bob@example.com"
bool(false)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.filter-var-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.filter-var-array.html" class="function" rel="rdfs-seeAlso">filter_var_array()</a> - Gets multiple variables and optionally filters them</span></li>
<li class="member"> <span class="function"><a href="function.filter-input.html" class="function" rel="rdfs-seeAlso">filter_input()</a> - Gets a specific external variable by name and optionally filters it</span></li>
<li class="member"> <span class="function"><a href="function.filter-input-array.html" class="function" rel="rdfs-seeAlso">filter_input_array()</a> - Gets external variables and optionally filters them</span></li>
<li class="member"><a href="filter.filters.html" class="xref">Types of filters</a></li>
<li class="member">information about the <a href="language.pseudo-types.html#language.types.callback" class="link">callback</a> type</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.filter-var-array.html">filter_var_array</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.funchand.html">Function Handling</a></div>
<div class="up"><a href="ref.filter.html">Filter Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
