関数・クラス解説
filter_input_array
version:PHP 5 >= 5.2.0, PHP 7 (公式)外部から変数を受け取り、オプションでそれらをフィルタリングする
公式リファレンス
書式
filter_input_array ( int $type [, mixed $definition [, bool $add_empty = TRUE ]] ) : mixed
説明
この関数を使用すると、大量のデータを取得する際に filter_input() を繰り返しコールする必要がなくなるので便利です。
パラメータ
- type
- INPUT_GET、INPUT_POST、 INPUT_COOKIE、INPUT_SERVER あるいは INPUT_ENV のいずれか。
- definition
- 引数を定義する配列。配列のキーとして使用できるのは 変数名を string で表したものです。 対応する値に使用できるのは、フィルタの型か配列 (フィルタ・フラグ・オプションを指定したもの) です。 配列の値として配列を使用する場合に使用できるキーは、 filter (フィルタの型)、 flags (フィルタに適用するフラグ) および options (フィルタに適用するオプション) です。理解を深めるために、以下の例を参照ください。 このパラメータには、フィルタ定数 を表す整数値を指定することもできます。 こうすると、入力配列のすべての値がそのフィルタで処理されます。
- add_empty
- 存在しないキーは NULL として返り値に追加します。
返値
成功した場合は要求された変数の値を含む配列。 FILTER_NULL_ON_FAILURE フラグが指定されない場合、 かつ type で指定された入力値の配列が得られなかった場合は、 この関数は NULL を返します。 type で指定された入力値の配列が得られなかった場合、 かつ FILTER_NULL_ON_FAILURE フラグが指定されていた場合は、 この関数は FALSE を返します。その他の理由で失敗した場合でも FALSE を返します。 フィルタが失敗した場合、配列の値は FALSE になります。 変数が設定されていない場合は、NULL になります。 フラグ FILTER_NULL_ON_FAILURE が指定されている場合は、変数が設定されていないときに FALSE、 フィルタリングに失敗した場合に NULL となります。 add_empty パラメータが FALSE の場合、 配列の要素は追加されません。
注意
注意: INPUT_SERVER 配列には、 キー REQUEST_TIME が存在しません。 あとで $_SERVER に追加されるからです。
サンプル
例1 filter_input_array() の例
error_reporting(E_ALL | E_STRICT);
/* データは、実際には POST リクエストでやってきます
$_POST = array(
'product_id' => 'libgd