<!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>Gets external variables and optionally filters them</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.filter-id.html">filter_id</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.filter-input.html">filter_input</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-input-array" class="refentry">
<div class="refnamediv">
<h1 class="refname">filter_input_array</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">filter_input_array</span> — <span class="dc-title">Gets external variables and optionally filters them</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.filter-input-array-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_input_array</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></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">$definition</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$add_empty</code><span class="initializer"> = true</span></span>
]] )</div>
<p class="para rdfs-comment">
This function is useful for retrieving many values without
repetitively calling <span class="function"><a href="function.filter-input.html" class="function">filter_input()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.filter-input-array-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
One of <strong><code>INPUT_GET</code></strong>, <strong><code>INPUT_POST</code></strong>,
<strong><code>INPUT_COOKIE</code></strong>, <strong><code>INPUT_SERVER</code></strong>, or
<strong><code>INPUT_ENV</code></strong>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">definition</code></em></span>
<dd>
<p class="para">
An array defining the arguments. A valid key is a <span class="type"><a href="language.types.string.html" class="type string">string</a></span>
containing a variable name and a valid value is either a <a href="filter.filters.html" class="link">filter type</a>, or an <span class="type"><a href="language.types.array.html" class="type array">array</a></span>
optionally specifying the filter, flags and options. If the value is an
array, valid keys are <em>filter</em> which specifies the
<a href="filter.filters.html" class="link">filter type</a>,
<em>flags</em> which specifies any flags that apply to the
filter, and <em>options</em> which specifies any options that
apply to the filter. See the example below for a better understanding.
</p>
<p class="para">
This parameter can be also an integer holding a <a href="filter.constants.html" class="link">filter constant</a>. Then all values in the
input array are filtered by this filter.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">add_empty</code></em></span>
<dd>
<p class="para">
Add missing keys as <strong><code>NULL</code></strong> to the return value.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.filter-input-array-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An array containing the values of the requested variables on success, or <strong><code>FALSE</code></strong>
on failure. An array value will be <strong><code>FALSE</code></strong> if the filter fails, or <strong><code>NULL</code></strong> if
the variable is not set. Or if the flag <strong><code>FILTER_NULL_ON_FAILURE</code></strong>
is used, it returns <strong><code>FALSE</code></strong> if the variable is not set and <strong><code>NULL</code></strong> if the filter
fails.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.filter-input-array-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5090">
<p><strong>Example #1 A <span class="function"><strong>filter_input_array()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />error_reporting</span><span style="color: #007700">(</span><span style="color: #0000BB">E_ALL </span><span style="color: #007700">| </span><span style="color: #0000BB">E_STRICT</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/* data actually came from POST<br />$_POST = array(<br /> 'product_id' => 'libgd<script>',<br /> 'component' => '10',<br /> 'versions' => '2.0.33',<br /> 'testscalar' => array('2', '23', '10', '12'),<br /> 'testarray' => '2',<br />);<br />*/<br /><br /></span><span style="color: #0000BB">$args </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'product_id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_SANITIZE_ENCODED</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'component' </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'filter' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_VALIDATE_INT</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'flags' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_REQUIRE_ARRAY</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'options' </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'min_range' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">'max_range' </span><span style="color: #007700">=> </span><span style="color: #0000BB">10</span><span style="color: #007700">)<br /> ),<br /> </span><span style="color: #DD0000">'versions' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_SANITIZE_ENCODED</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'doesnotexist' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_VALIDATE_INT</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'testscalar' </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">'filter' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_VALIDATE_INT</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'flags' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_REQUIRE_SCALAR</span><span style="color: #007700">,<br /> ),<br /> </span><span style="color: #DD0000">'testarray' </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">'filter' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_VALIDATE_INT</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'flags' </span><span style="color: #007700">=> </span><span style="color: #0000BB">FILTER_REQUIRE_ARRAY</span><span style="color: #007700">,<br /> )<br /><br />);<br /><br /></span><span style="color: #0000BB">$myinputs </span><span style="color: #007700">= </span><span style="color: #0000BB">filter_input_array</span><span style="color: #007700">(</span><span style="color: #0000BB">INPUT_POST</span><span style="color: #007700">, </span><span style="color: #0000BB">$args</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$myinputs</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"\n"</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>
array(6) {
["product_id"]=>
array(1) {
[0]=>
string(17) "libgd%3Cscript%3E"
}
["component"]=>
array(1) {
[0]=>
int(10)
}
["versions"]=>
array(1) {
[0]=>
string(6) "2.0.33"
}
["doesnotexist"]=>
NULL
["testscalar"]=>
bool(false)
["testarray"]=>
array(1) {
[0]=>
int(2)
}
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.filter-input-array-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>
Added <em><code class="parameter">add_empty</code></em> parameter.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.filter-input-array-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
There is no <em>REQUEST_TIME</em> key in
<strong><code>INPUT_SERVER</code></strong> array because it is inserted into the
<var class="varname"><var class="varname"><a href="reserved.variables.server.html" class="classname">$_SERVER</a></var></var> later.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.filter-input-array-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<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-var-array.html" class="function" rel="rdfs-seeAlso">filter_var_array()</a> - Gets multiple variables and optionally filters them</span></li>
<li class="member"><a href="filter.filters.html" class="xref">Types of filters</a></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-id.html">filter_id</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.filter-input.html">filter_input</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>
