filter_input

filter_id

[edit] Last updated: Fri, 25 May 2012

filter_input_array

(PHP 5 >= 5.2.0)

filter_input_array — Obtiene variables externas y opcionalmente las filtra

Descripción

mixed filter_input_array ( int $type [, mixed $definition ] )

Esta función es útil para recuperar muchos valores sin necesidad de hacer repetidas llamadas a filter_input().

Parámetros

type

Una de las siguientes: INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER o INPUT_ENV.

definition

Un array definiendo los argumentos. Una clave válida será aquella que contiene un string con el nombre de una variable y un valor válido aquel que o bien es un tipo filter type o un array especificando opcionalmente el filtro, flags y opciones. Si el valor es un array, las claves válidas serán: filter que especifica el tipo filter type, flags que define cualquier flag que deba aplicarse a los filtros, y options que establece cualquier opción que se deba aplicar al filtro. Para entender mejor su funcionamiento, vea el ejemplo inferior.

Este parámetro puede ser también un entero que indique una constante de filtro. Entonces todos los valores en el array de entrada son filtrados por ese filtro.

Valores devueltos

En caso de éxito, un array con los valores de las variables que se han pedido o FALSE en caso de fallo. Un valor del array puede ser FALSE si el filtro falla o NULL si la variable no está creada. O, si se usa el flag FILTER_NULL_ON_FAILURE y la variable no está definida retorna FALSE y NULL si el filtro falla.

Ejemplos

Ejemplo #1 Un ejemplo con filter_input_array()


<?php
error_reporting(E_ALL | E_STRICT);
/* Los datos vienen realmente por POST
$_POST = array(
    'id_producto'    => 'libgd<script>',
    'componente'     => '10',
    'version'      => '2.0.33',
    'test_escalar'    => array('2', '23', '10', '12'),
    'test_array'     => '2',
);
*/

$args = array(
    'id_producto'   => FILTER_SANITIZE_ENCODED,
    'componente'    => array('filter'    => FILTER_VALIDATE_INT,
                            'flags'     => FILTER_REQUIRE_ARRAY, 
                            'options'   => array('min_range' => 1, 'max_range' => 10)
                           ),
    'version'     => FILTER_SANITIZE_ENCODED,
    'no_existe' => FILTER_VALIDATE_INT,
    'test_escalar'   => array(
                            'filter' => FILTER_VALIDATE_INT,
                            'flags'  => FILTER_REQUIRE_SCALAR,
                           ),
    'test_array'    => array(
                            'filter' => FILTER_VALIDATE_INT,
                            'flags'  => FILTER_REQUIRE_ARRAY,
                           )

);

$mis_entradas = filter_input_array(INPUT_POST, $args);

var_dump($mis_entradas);
echo "\n";
?>

El resultado del ejemplo sería:

array(6) {
  ["id_producto"]=>
  array(1) {
    [0]=>
    string(17) "libgd%3Cscript%3E"
  }
  ["componente"]=>
  array(1) {
    [0]=>
    int(10)
  }
  ["version"]=>
  array(1) {
    [0]=>
    string(6) "2.0.33"
  }
  ["no_existe"]=>
  NULL
  ["test_escalar"]=>
  bool(false)
  ["test_array"]=>
  array(1) {
    [0]=>
    int(2)
  }
}

Notas

Nota:
No existe la clave REQUEST_TIME en la matriz INPUT_SERVER porque este valor se inserta posteriormente en $_SERVER.

Ver también

filter_input() - Toma una variable externa concreta por nombre y opcionalmente la filtra
filter_var_array() - Retorna múltiple variables y opcionalmente las filtra
Tipos de filtros

filter_input

filter_id

[edit] Last updated: Fri, 25 May 2012

add a note User Contributed Notes filter_input_array

Anonymous 22-Apr-2010 06:12


Beware: if none of the arguments is set, this function returns NULL, not an array of NULL values.



/* No POST vars set in request

$_POST = array();

*/



$args = array('some_post_var' => FILTER_VALIDATE_INT);

$myinputs = filter_input_array(INPUT_POST, $args);

var_dump($myinputs);



Expected Output: array(1) { ["some_post_var"]=> NULL } 



Actual Output: NULL

ville at N0SPAM dot zydo dot com 12-Mar-2010 08:18


While filtering input arrays, be careful of what flags you set besides FILTER_REQUIRE_ARRAY. For example, setting the flags like so:





<?php


$filter = array(


'myInputArr' => array('filter' => FILTER_SANITIZE_STRING,


                      'flags' => array('FILTER_FLAG_STRIP_LOW', 'FILTER_REQUIRE_ARRAY'))


);





$form_inputs = filter_input_array(INPUT_POST, $filter);


?>





.. will result in a blank $form_inputs['myInputArr'] regardless of what $_POST['myInputArr'] contains.

kibblewhite at live dot com 26-Jan-2009 12:35


If you are trying to handling multiple form inputs with same name, then you must assign the `'flags'  => FILTER_REQUIRE_ARRAY` to the definitions entry.



Example, you have a html form as such:

<form>

 <input name="t1[]" value="Some string One" />

 <input name="t1[]" value="Another String Two" />

</form>



Your definitions array will look a little like this:

$args = array(

  't1'    => array(

      'name' => 't1',

      'filter' => FILTER_SANITIZE_STRING,

      'flags'  => FILTER_REQUIRE_ARRAY)

);

kdeloach at gmail dot com 12-Aug-2008 06:42


@iam4webwork



This is not specific to filter_input.  If you have an element in HTML called names[], it can be accessed by calling $_POST['names'].

Kevin 08-Jul-2008 12:37


Looks like filter_input_array isn't aware of changes to the input arrays that were made before calling filter_input_array. Instead, it always looks at the originally submitted input arrays.



So this will not work:



$_POST['my_float_field'] = str_replace(',','.',$_POST['my_float_field']);

$args = array('my_float_field',FILTER_VALIDATE_FLOAT);

$result = filter_input_array(INPUT_POST, $args);

phpnotes dot 20 dot zsh at spamgourmet dot com 10-Sep-2007 04:32


The above example will actually output "NULL" because of the undefined variable doesnotexist - see http://bugs.php.net/bug.php?id=42608.

Sinured 22-Aug-2007 04:10


extract() is a very convenient way of copying all those variables to the local scope. (see http://www.php.net/extract)

iam4webwork at NOSPAM dot hotmail dot com 07-Jun-2007 07:02


The above example raises other questions such as how one would validate an html array.  In the input form each input tag that refers to an html array would be named for example testarray[].  However, after the form is submitted, the syntax for validating the values is different from  the expected $_POST['testarray[]']. Instead one has to drop the braces and validate as follows, assuming that testarray[] is supposed to be an html array of numerical values:



Valid test:



echo '*';

echo filter_input(

INPUT_POST,

'testarray',

FILTER_VALIDATE_INT,

FILTER_REQUIRE_ARRAY

);

echo '*';



But the following is an invalid test that results in 2 consequtive asterisks only!



echo '*';

echo filter_input(INPUT_POST,

'testarray[]',

FILTER_VALIDATE_INT,

FILTER_REQUIRE_ARRAY

);

echo '*';



So, there is a naming inconsistency going on, as after the form is submitted, one has to forget about the original name of the submitted array by dropping its braces. Maybe when the PECL/Filter extension is reviewed again, the great ones might consider making the syntax a little more forgiving.

add a note