filter_input_array

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

説明

arrayfalsenull filter_input_array(int $type, arrayint $options = FILTER_DEFAULT, bool $add_empty = true)

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

パラメータ

type: 定数 INPUT_* のうちのひとつ。
警告
フィルタされるスーパーグローバルの内容は、ユーザーがスーパーグローバルに手を加える前の、 SAPI が提供する "生の" ものです。変更されたスーパーグローバルの値をフィルタするには、 filter_var_array を代わりに使います。
options: オプション、またはエントリごとに適用するフィルタの連想配列。フィルタは検証フィルタ FILTER_VALIDATE_* または除去フィルタ FILTER_SANITIZE_* が使えます。オプションの値は、 array に存在するキーをキーとして、そのエントリに適用するフィルタを値とする連想配列、または、そのエントリにどのフィルタを、どのように適用するかを記述した連想配列です。どのようにフィルタを適用するかを連想配列に記述する場合、どのフィルタを対応する値に適用するかを 'filter' キーに含めなければいけません。 'filter' キーに指定できるのは、 FILTER_VALIDATE_*, FILTER_SANITIZE_*, FILTER_UNSAFE_RAW, FILTER_CALLBACK のうちのいずれかです。オプションで 'flags' キーには、フィルタに適用するフラグを指定できますし、 'options' には、フィルタに適用するオプションを指定できます。
add_empty: 返り値の配列に対して、キーが存在しない場合に null を追加します。

戻り値

成功した場合は要求された変数の値を含む配列。

失敗した場合、false を返します。 type で指定された入力値の配列が得られなかった場合、かつ FILTER_NULL_ON_FAILURE フラグが指定されていた場合は、例外的に null を返します。

入力された配列に欠けているエントリがあった場合、 add_empty が true のときは返される配列に追加されます。この場合、欠けているエントリには、FILTER_NULL_ON_FAILURE を使わない限り null が設定されます。 FILTER_NULL_ON_FAILURE を使った場合には、false が設定されます。

フィルタが失敗した場合、配列の値は false になります。但し、FILTER_NULL_ON_FAILURE が使われている場合を除きます。使われている場合、配列の値は null になります。

注意

注意:
INPUT_SERVER 配列には、キー REQUEST_TIME が存在しません。あとで $_SERVER に追加されるからです。

参考

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