filter_input_array

(PHP 5 >= 5.2.0)

filter_input_array — 外部から変数を受け取り、オプションでそれらをフィルタリングする

説明

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

この関数を使用すると、大量のデータを取得する際に filter_input() を繰り返しコールする必要がなくなるので便利です。

パラメータ

type

INPUT_GET、INPUT_POST、 INPUT_COOKIE、INPUT_SERVER、 INPUT_ENV、INPUT_SESSION あるいは INPUT_REQUEST のいずれか。

definition

引数を定義する配列。配列のキーとして使用できるのは変数名を string で表したものです。対応する値に使用できるのは、フィルタの型か配列 (フィルタ・フラグ・オプションを指定したもの) です。配列の値として配列を使用する場合に使用できるキーは、 filter (フィルタの型)、 flags (フィルタに適用するフラグ) および options (フィルタに適用するオプション) です。理解を深めるために、以下の例を参照ください。

このパラメータには、フィルタ定数を表す整数値を指定することもできます。こうすると、入力配列のすべての値がそのフィルタで処理されます。

返り値

成功した場合は要求された変数の値を含む配列、あるいは失敗した場合に FALSE を返します。配列の値は、フィルタリングに失敗した場合には FALSE、変数が設定されていない場合は NULL となります。フラグ FILTER_NULL_ON_FAILURE が指定されている場合は、変数が設定されていないときに FALSE、フィルタリングに失敗した場合に NULL となります。

例

例1 filter_input_array() の例


<?php
error_reporting(E_ALL | E_STRICT);
/* データは、実際には 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";
?>

上の例の出力は以下となります。

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

参考

filter_input() - 指定した名前の変数を外部から受け取り、オプションでそれをフィルタリングする
filter_var_array() - 複数の変数を受け取り、オプションでそれらをフィルタリングする

filter_input

filter_id

Last updated: Fri, 30 Jan 2009

add a note User Contributed Notes
filter_input_array

kibblewhite at live dot com
26-Jan-2009 05: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 10: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 04: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 08: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 08: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
08-Jun-2007 11: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

filter_input

filter_id

Last updated: Fri, 30 Jan 2009