filter_var_array

複数の変数を受け取り、オプションでそれらをフィルタリングする

説明

arrayfalsenull filter_var_array(array $array, arrayint $options = FILTER_DEFAULT, bool $add_empty = true)

検証フィルタ FILTER_VALIDATE_* や、除去フィルタ FILTER_SANITIZE_*、またはカスタムフィルタを使って連想配列をフィルタリングします。

パラメータ

array: フィルタリングするデータを保持している連想配列
options: オプション、またはエントリごとに適用するフィルタの連想配列。フィルタは検証フィルタ FILTER_VALIDATE_* または除去フィルタ FILTER_SANITIZE_* が使えます。オプションの値は、 array に存在するキーをキーとして、そのエントリに適用するフィルタを値とする連想配列、または、そのエントリにどのフィルタを、どのように適用するかを記述した連想配列です。どのようにフィルタを適用するかを連想配列に記述する場合、どのフィルタを対応する値に適用するかを 'filter' キーに含めなければいけません。 'filter' キーに指定できるのは、 FILTER_VALIDATE_*, FILTER_SANITIZE_*, FILTER_UNSAFE_RAW, FILTER_CALLBACK のうちのいずれかです。オプションで 'flags' キーには、フィルタに適用するフラグを指定できますし、 'options' には、フィルタに適用するオプションを指定できます。
add_empty: 返り値の配列に対して、キーが存在しない場合に null を追加します。

戻り値

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

例

例1 filter_var_array の例

<?php

$data = [
    'product_id' => 'libgd<script>',
    'component'  => '10',
    'versions'   => '2.0.33',
    'testscalar' => ['2', '23', '10', '12'],
    'testarray'  => '2',
];

$filters = [
    'product_id'   => FILTER_SANITIZE_ENCODED,
    'component'    => [
        'filter'   => FILTER_VALIDATE_INT,
        'flags'    => FILTER_FORCE_ARRAY,
        'options'  => [
            'min_range' => 1,
            'max_range' => 10,
        ],
    ],
    'versions'     => [
        'filter' => FILTER_SANITIZE_ENCODED
    ],
    'testscalar'   => [
        'filter' => FILTER_VALIDATE_INT,
        'flags'  => FILTER_REQUIRE_SCALAR,
    ],
    'testarray'    => [
        'filter' => FILTER_VALIDATE_INT,
        'flags'  => FILTER_FORCE_ARRAY,
    ],
    'doesnotexist' => FILTER_VALIDATE_INT,
];

var_dump(filter_var_array($data, $filters));

?>

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

array(6) {
  ["product_id"]=>
  string(17) "libgd%3Cscript%3E"
  ["component"]=>
  array(1) {
    [0]=>
    int(10)
  }
  ["versions"]=>
  string(6) "2.0.33"
  ["testscalar"]=>
  bool(false)
  ["testarray"]=>
  array(1) {
    [0]=>
    int(2)
  }
  ["doesnotexist"]=>
  NULL
}

参考

filter_input_array
filter_var
filter_input
検証フィルタ FILTER_VALIDATE_*
除去フィルタ FILTER_SANITIZE_*