<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.filter-input-array" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">

<refnamediv>

<refname>filter_input_array</refname>

<refpurpose>Obtiene variables externas y opcionalmente las filtra</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>array</type><type>false</type><type>null</type></type><methodname>filter_input_array</methodname>

<methodparam><type>int</type><parameter>type</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>array</type><type>int</type></type><parameter>options</parameter><initializer><constant>FILTER_DEFAULT</constant></initializer></methodparam>

<methodparam choice="opt"><type>bool</type><parameter>add_empty</parameter><initializer>&true;</initializer></methodparam>

</methodsynopsis>

<para>

Esta función es útil para recuperar muchos valores sin necesidad de

llamar repetidamente a <function>filter_input</function>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

<term><parameter>type</parameter></term>

<listitem>

<simpara>

Una de las constantes <constant>INPUT_<replaceable>*</replaceable></constant>.

</simpara>

<warning>

<simpara>

El contenido de la superglobal que se está filtrando es el original

"sin procesar" proporcionado por <acronym>SAPI</acronym>,

antes de cualquier modificación del usuario a la superglobal.

Para filtrar una superglobal modificada, utilice

<function>filter_var_array</function> en su lugar.

</simpara>

</warning>

</listitem>

</varlistentry>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.filter-var-array')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='options']]]/.)">

<xi:fallback/>

</xi:include>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.filter-var-array')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='add_empty']]]/.)">

<xi:fallback/>

</xi:include>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

En caso de éxito, un &array; que contiene los valores de las variables solicitadas.

</simpara>

<simpara>

En caso de fallo, se devuelve &false;.

Excepto si el fallo es que el array de entrada designado por

<parameter>type</parameter> no está poblado, donde se devuelve &null;

si se usa el flag <constant>FILTER_NULL_ON_FAILURE</constant>.

</simpara>

<simpara>

Las entradas faltantes del array de entrada se rellenarán en el array

devuelto si <parameter>add_empty</parameter> es &true;.

En cuyo caso, las entradas faltantes se establecerán en &null;,

a menos que se use el flag <constant>FILTER_NULL_ON_FAILURE</constant>,

en cuyo caso será &false;.

</simpara>

<simpara>

Un valor del array devuelto será &false; si el filtro falla,

a menos que se use el flag <constant>FILTER_NULL_ON_FAILURE</constant>,

en cuyo caso será &null;.

</simpara>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

No hay una clave <literal>REQUEST_TIME</literal> en el array

<constant>INPUT_SERVER</constant> porque este valor es insertado en

<varname>$_SERVER</varname> posteriormente.

</para>

</note>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>filter_input</function></member>

<member><function>filter_var</function></member>

<member><function>filter_var_array</function></member>

<member>

Filtros de validación

<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>

</member>

<member>

Filtros de saneación

<constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>

</member>

</simplelist>

</refsect1>

</refentry>