filter_input

filter_id

[edit] Last updated: Fri, 24 May 2013

filter_input_array

(PHP 5 >= 5.2.0)

filter_input_array — Récupère plusieurs valeurs externes et les filtre

Description

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

Cette fonction est utile pour récupérer plusieurs valeurs sans avoir à appeler plusieurs fois la fonction filter_input().

Liste de paramètres

type

Une constante parmi INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER ou INPUT_ENV.

definition

Un tableau définissant les arguments. Une clé valide est une chaîne de caractères contenant le nom de la variable et une valeur valide est soit le type d'un filtre, soit un tableau spécifiant le filtre, les drapeaux et les options. Si la valeur est un tableau, les clés valides sont filter qui spécifie le type du filtre, flags qui spécifie tous les drapeaux à appliquer au filtre, et options qui spécifie toutes les options à appliquer au filtre. Voir l'exemple ci-dessous pour une meilleure compréhension.

Ce paramètre peut également être un entier contenant une constante de filtre. Ensuite, toutes les valeurs du tableau d'entrée seront filtrées par ce filtre.

Valeurs de retour

Un tableau contenant les valeurs des variables demandées en cas de succès, ou FALSE si une erreur survient. Un tableau de valeurs peut valoir FALSE si le filtre échoue, ou NULL si la variable n'est pas définie. Ou, si le drapeau FILTER_NULL_ON_FAILURE est utilisé, la fonction retournera FALSE si la variable n'est pas définie et NULL si le filtre échoue.

Exemples

Exemple #1 Exemple avec filter_input_array()


<?php
error_reporting(E_ALL | E_STRICT);
/* les données arrivent depuis POST
$_POST = array(
    'product_id'    => 'libgd<script>',
    'component'     => '10',
    'versions'      => '2.0.33',
    'testscalar'    => array('2', '23', '10', '12'),
    'testarray'     => '2',
);
*/

$args = array(
    'product_id'   => FILTER_SANITIZE_ENCODED,
    'component'    => array('filter'    => FILTER_VALIDATE_INT,
                            'flags'     => FILTER_REQUIRE_ARRAY, 
                            'options'   => array('min_range' => 1, 'max_range' => 10)
                           ),
    'versions'     => FILTER_SANITIZE_ENCODED,
    'doesnotexist' => FILTER_VALIDATE_INT,
    'testscalar'   => array(
                            'filter' => FILTER_VALIDATE_INT,
                            'flags'  => FILTER_REQUIRE_SCALAR,
                           ),
    'testarray'    => array(
                            'filter' => FILTER_VALIDATE_INT,
                            'flags'  => FILTER_REQUIRE_ARRAY,
                           )

);

$myinputs = filter_input_array(INPUT_POST, $args);

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

L'exemple ci-dessus va afficher :

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)
  }
}

Notes

Note:
Il n'y a pas de clé REQUEST_TIME dans le tableau INPUT_SERVER car elle est insérée dans la variable $_SERVER plus tard.

Voir aussi

filter_input() - Récupère une variable externe et la filtre
filter_var_array() - Récupère plusieurs variables et les filtre
Types de filtres

filter_input

filter_id

[edit] Last updated: Fri, 24 May 2013

add a note User Contributed Notes filter_input_array - [8 notes]

down

ville at N0SPAM dot zydo dot com ¶

3 years ago


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.

down

Anonymous ¶

3 years ago


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

down

kibblewhite at live dot com ¶

4 years ago


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)

);

down

kdeloach at gmail dot com ¶

4 years ago


@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'].

down

Kevin ¶

4 years ago


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);

down

phpnotes dot 20 dot zsh at spamgourmet dot com ¶

5 years ago


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

down

Sinured ¶

5 years ago


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

down

iam4webwork at NOSPAM dot hotmail dot com ¶

5 years ago


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