ホーム > PHP関数リファレンス > フィルタ系 > php filter_var_array 配列で複数のデータをフィルタリングして値をチェックする

UPDATE:2019年12月11日

php filter_var_array 配列で複数のデータをフィルタリングして値をチェックする

PHP4 PHP5 PHP7

php filter_var_array 配列で複数のデータをフィルタリングして値をチェックする

◆ php filter_var_array() 内容

◆ php filter_var_array() パラメーター

◆ php filter_var_array() 返り値

◆ php filter_var_array() 変更履歴

◆ 検証用フィルタ

◆ 除去用フィルタ

◆ フィルタフラグ

php filter_var_array() サンプル

php filter_var_array 配列で複数のデータをフィルタリングして値をチェックする

php filter_var_array() 書式
mixed 配列や FALSE、NULL = filter_var_array(array $data [, mixed $definition [, bool $add_empty = TRUE ]]);
フィルタリングに失敗した場合 FALSE や NULL を返す
[ ]省略可

説明	複数のデータを一括でフィルタリングする。フィルタリングとは見込んでいるデータかどうかチェックすることです。
引数	array 必須 $data	フィルタリングするデータを格納した配列。キーが文字列の連想配列です。
引数	mixed $definition	チェックする配列に対して、各データにどのようなフィルタを適応するかを定義する配列を指定します。フィルタを定義する配列です。この配列のキー名として利用できるのは、データをチェックする配列のキー名や、また、変数名を string で表したものです。キー名に対応する値はフィルタの型（検証用フィルタ、除去用フィルタ）か、配列（フィルタ／フラグ／オプションを指定した配列）です。
引数	bool $add_empty	フィルタリングする配列の中に存在しないキーは NULL として返り値に追加します。
返り値	mixed 配列 \| FALSE \| NULL	フィルタリングが成功した場合は指定されたデータの値を返します。失敗した場合に FALSE を返します。

サンプル

<?php
//データをチェックする配列
$data = array(
	'userId' => 1,
	'name' => 'wepicks taro',
);

//フィルタリングする配列に対応したフィルタの種類
//連想配列のキー名を合わせる
$args = array(
	'userId' => FILTER_VALIDATE_INT,
	'name' => FILTER_VALIDATE_INT,
);

//フィルタリング
$myinputs = filter_var_array($data, $args);

//結果
echo '<pre>';
var_dump($myinputs);
echo '</pre>';
?>

//出力
array(2) {
  ["userId"]=>
  int(1)
  ["name"]=>
  bool(false)
}

<?php

//データをチェックする配列

$data = array(

'userId' => 1,

'name' => 'wepicks taro',

);

//フィルタリングする配列に対応したフィルタの種類

//連想配列のキー名を合わせる

$args = array(

'userId' => FILTER_VALIDATE_INT,

'name' => FILTER_VALIDATE_INT,

);

//フィルタリング

$myinputs = filter_var_array($data, $args);

//結果

echo '<pre>';

var_dump($myinputs);

echo '</pre>';

//出力

array(2) {

["userId"]=>

int(1)

["name"]=>

bool(false)

}

◆ 引数や返り値のデータ型の説明

データ型引数や返り値のデータ型の説明

引数や返り値	内容（引数 \| 返り値）
string	文字列型を受け入れる。 \| 文字列型を返す。
int	整数型を受け入れる。 \| 整数型を返す。
float	浮動小数点数型を受け入れる。 \| 浮動小数点数型を返す。
bool	論理型を受け入れる。 \| 論理型を返す。
number	整数型または浮動小数点数型を受け入れる。 \| 整数型または浮動小数点数型を返す。
array	配列型を受け入れる。 \| 配列型を返す。
object	オブジェクト型を受け入れる。 \| オブジェクト型を返す。
array\|object	配列型またはオブジェクト型を受け入れる。 \| 配列型またはオブジェクト型を返す。
mixed	複数のデータ型を受け入れる（パラメーター）、或いは、返す（返り値）ことが可能。全てのデータ型ではありません。例えば gettype()関数は全ての型を受け入れますが、一方、str_replace()関数は、文字列型と配列型のみを受け入れます。また、reset()関数や end()関数は、返り値に配列型と論理型（FALSE）を返します。
void	パラメータ一覧で void が使用されている場合、その関数がパラメータを受け付けないことを表します。 \| 返り値の型が void である場合、返り値に意味がないことを表します。
callback	callback 疑似型がこのドキュメントで使われていたのは、PHP 5.4 で callable タイプヒントが導入される前のことでした。両者はまったく同じ意味です。

◆ php filter_var_array() 内容

複数データをフィルタリングする

1つの値が格納された変数をフィルタリングするには filter_var()関数を利用しますが、複数の値や変数をチェックするには filter_var_array()関数 を利用します。複数の値や変数が格納された配列（※キーが文字列の連想配列）を一括でフィルタリングできます。フィルタリングとは、対象の変数が存在するか、想定しているデータ型か、格納している値は想定している内容か、など、データのチェックを行うことです。入力チェックやバリデーションなどとも言います。

フィルタリングはソフトの安定性や安全性にとって重要な処理です。

パラメーター array $data で複数の値が格納された配列を指定します。以下の例では複数の値が格納された連想配列（※キーは文字列）をフィルタリングします。

<?php
//チェックする連想配列
$data = array(
	'userId' => 1,
	'name' => 'wepicks taro',
);

<?php

//チェックする連想配列

$data = array(

'userId' => 1,

'name' => 'wepicks taro',

);

この連想配列に対応したフィルタの種類を指定する mixed $definition 配列を用意します。その際、チェックする連想配列のキー名に合わせてフィルタの種類を指定します。

<?php
//チェックする連想配列の各キーと適応するフィルタの種類を指定
$args = array(
	'userId' => FILTER_VALIDATE_INT,
	'name' => FILTER_VALIDATE_INT,
);

<?php

//チェックする連想配列の各キーと適応するフィルタの種類を指定

$args = array(

'userId' => FILTER_VALIDATE_INT,

'name' => FILTER_VALIDATE_INT,

);

フィルタリングして結果を受け取ります。

<?php
//フィルタリング
$myinputs = filter_var_array($data, $args);

//結果
echo '<pre>';
var_dump($myinputs);
echo '</pre>';
?>

<?php

//フィルタリング

$myinputs = filter_var_array($data, $args);

//結果

echo '<pre>';

var_dump($myinputs);

echo '</pre>';

実行結果

array(2) {
["userId"]=>
int(1)
["name"]=>
bool(false)
}

◆ php filter_var_array() パラメーター

値	内容
必須 array $data	フィルタリングするデータを格納した配列。キーが文字列の連想配列です。
mixed $definition	チェックする配列に対して、各データにどのようなフィルタを適応するかを定義する配列を指定します。フィルタを定義する配列です。この配列のキー名として利用できるのは、データをチェックする配列のキー名や、また、変数名を string で表したものです。キー名に対応する値はフィルタの型（検証用フィルタ、除去用フィルタ）か、配列（フィルタ／フラグ／オプションを指定した配列）です。
bool $add_empty	フィルタリングする配列の中に存在しないキーは NULL として返り値に追加します。

◆ php filter_var_array() 返り値

mixed
フィルタリングが成功した場合は指定されたデータの値を返します。失敗した場合に FALSE を返します。

mixed 複数のデータ型を受け入れる（パラメーター）、或いは、返す（返り値）ことが可能。全てのデータ型ではありません。例えば gettype()関数は全ての型を受け入れますが、一方、str_replace()関数は、文字列型と配列型のみを受け入れます。また、reset()関数や end()関数は、返り値に配列型と論理型（FALSE）を返します。

◆ php filter_var_array() 変更履歴

PHPバージョン	変更内容
–	–

検証用フィルタ一覧

ID	名前	オプション	フラグ	説明
`FILTER_VALIDATE_BOOLEAN`	'boolean'	`default`	`FILTER_NULL_ON_FAILURE`	'1'、'true'、'on' および 'yes' の場合に `TRUE`、それ以外の場合に `FALSE` を返します。 `FILTER_NULL_ON_FAILURE` が設定されている場合は、 `FALSE` が返されるのは '0'、'false'、'off'、'no' および '' の場合のみとなります。 boolean 以外の値については `NULL` を返します。
`FILTER_VALIDATE_EMAIL`	'validate_email'	`default`	`FILTER_FLAG_EMAIL_UNICODE`	値が妥当な e-mail アドレスであるかどうかを検証します。この検証は、e-mail アドレスが RFC 822 に沿った形式であるかどうかを確かめます。ただし、コメント、空白の折り返し (whitespace folding) およびドットなしドメイン名 (dotless domain name) には対応していません。
`FILTER_VALIDATE_FLOAT`	'float'	`default`, `decimal`	`FILTER_FLAG_ALLOW_THOUSAND`	値が float であるかどうかを検証し、成功した場合は値を float に変換します。
`FILTER_VALIDATE_INT`	'int'	`default`, `min_range`, `max_range`	`FILTER_FLAG_ALLOW_OCTAL`, `FILTER_FLAG_ALLOW_HEX`	値が整数であるかどうか、オプションで指定した範囲内にあるかどうかを検証し、成功した場合は整数に変換します。
`FILTER_VALIDATE_IP`	'validate_ip'	`default`	`FILTER_FLAG_IPV4`, `FILTER_FLAG_IPV6`, `FILTER_FLAG_NO_PRIV_RANGE`, `FILTER_FLAG_NO_RES_RANGE`	値が IP アドレスであるかどうかを検証します。オプションで IPv4 あるいは IPv6 のみの指定、プライベートアドレスや予約済みアドレスではないことの指定もできます。
`FILTER_VALIDATE_MAC`	'validate_mac_address'	`default`		値が MAC アドレスであるかどうかを検証します。
`FILTER_VALIDATE_REGEXP`	'validate_regexp'	`default`, `regexp`		値が、Perl 互換の正規表現 `regexp` に一致するかどうかを検証します。
`FILTER_VALIDATE_URL`	'validate_url'	`default`	`FILTER_FLAG_SCHEME_REQUIRED`, `FILTER_FLAG_HOST_REQUIRED`, `FILTER_FLAG_PATH_REQUIRED`, `FILTER_FLAG_QUERY_REQUIRED`	値が URL 形式である (» こちらに準拠している) かどうか、オプションで、必須コンポーネントが含まれているかどうかを検証します。妥当な URL が、HTTP プロトコル http:// を指定しているとは限りません。つまり、その URL が期待通りのプロトコル (ssh:// や mailto: など) を使っているかどうか、さらなる検証が必要だということです。この関数は、ASCII の URL のみを正しいとみなすことに注意しましょう。国際化ドメイン名 (非 ASCII 文字を含むもの) は失敗します。

除去用フィルタ一覧

ID	名前	フラグ	説明
`FILTER_SANITIZE_EMAIL`	'email'		英字、数字および !#$%&'+-=?^_`{\|}~@.[]* 以外のすべての文字を取り除きます。
`FILTER_SANITIZE_ENCODED`	'encoded'	`FILTER_FLAG_STRIP_LOW`, `FILTER_FLAG_STRIP_HIGH`, `FILTER_FLAG_STRIP_BACKTICK`, `FILTER_FLAG_ENCODE_LOW`, `FILTER_FLAG_ENCODE_HIGH`	文字列を URL エンコードします。オプションで、特殊文字を取り除いたりエンコードしたりします。
`FILTER_SANITIZE_MAGIC_QUOTES`	'magic_quotes'		addslashes() を適用します。
`FILTER_SANITIZE_NUMBER_FLOAT`	'number_float'	`FILTER_FLAG_ALLOW_FRACTION`, `FILTER_FLAG_ALLOW_THOUSAND`, `FILTER_FLAG_ALLOW_SCIENTIFIC`	数字、+- およびオプションで .,eE 以外のすべての文字を取り除きます。
`FILTER_SANITIZE_NUMBER_INT`	'number_int'		数字、プラス記号、マイナス記号以外のすべての文字を取り除きます。
`FILTER_SANITIZE_SPECIAL_CHARS`	'special_chars'	`FILTER_FLAG_STRIP_LOW`, `FILTER_FLAG_STRIP_HIGH`, `FILTER_FLAG_STRIP_BACKTICK`, `FILTER_FLAG_ENCODE_HIGH`	''<>& および ASCII 値が 32 未満の文字を HTML エスケープします。オプションで、特殊文字を取り除いたりエンコードしたりします。
`FILTER_SANITIZE_FULL_SPECIAL_CHARS`	'full_special_chars'	`FILTER_FLAG_NO_ENCODE_QUOTES`,	htmlspecialchars() に `ENT_QUOTES` を指定してコールするのと同じです。クォートのエンコードを無効にするには `FILTER_FLAG_NO_ENCODE_QUOTES` を設定します。 htmlspecialchars() と同様、このフィルタは default_charset に対応しています。現在の文字セットで無効な文字となるバイトシーケンスが検出されると文字列全体を拒否し、結果は長さ 0 の文字列となります。このフィルタをデフォルトのフィルタとして使う場合は、以下の警告を参考にしてデフォルトのフラグを 0 に設定しましょう。
`FILTER_SANITIZE_STRING`	'string'	`FILTER_FLAG_NO_ENCODE_QUOTES`, `FILTER_FLAG_STRIP_LOW`, `FILTER_FLAG_STRIP_HIGH`, `FILTER_FLAG_STRIP_BACKTICK`, `FILTER_FLAG_ENCODE_LOW`, `FILTER_FLAG_ENCODE_HIGH`, `FILTER_FLAG_ENCODE_AMP`	タグを取り除きます。オプションで、特殊文字を取り除いたりエンコードしたりします。
`FILTER_SANITIZE_STRIPPED`	'stripped'		'string' フィルタのエイリアス。
`FILTER_SANITIZE_URL`	'url'		英字、数字および $-_.+!'(),{}\|\\^~[]`<>#%';/?:@&=* 以外のすべての文字を取り除きます。
`FILTER_UNSAFE_RAW`	'unsafe_raw'	`FILTER_FLAG_STRIP_LOW`, `FILTER_FLAG_STRIP_HIGH`, `FILTER_FLAG_STRIP_BACKTICK`, `FILTER_FLAG_ENCODE_LOW`, `FILTER_FLAG_ENCODE_HIGH`, `FILTER_FLAG_ENCODE_AMP`	何もせず、オプションで特殊文字を取り除いたりエンコードしたりします。 `FILTER_DEFAULT` は、このフィルタのエイリアスです。

フィルタフラグ

ID	使える場所	説明
`FILTER_FLAG_STRIP_LOW`	`FILTER_SANITIZE_ENCODED`, `FILTER_SANITIZE_SPECIAL_CHARS`, `FILTER_SANITIZE_STRING`, `FILTER_UNSAFE_RAW`	コードが 32 未満の文字を除去します。
`FILTER_FLAG_STRIP_HIGH`	`FILTER_SANITIZE_ENCODED`, `FILTER_SANITIZE_SPECIAL_CHARS`, `FILTER_SANITIZE_STRING`, `FILTER_UNSAFE_RAW`	コードが 127 より大きい文字を除去します。
`FILTER_FLAG_STRIP_BACKTICK`	`FILTER_SANITIZE_ENCODED`, `FILTER_SANITIZE_SPECIAL_CHARS`, `FILTER_SANITIZE_STRING`, `FILTER_UNSAFE_RAW`	バックティック文字を除去します。
`FILTER_FLAG_ALLOW_FRACTION`	`FILTER_SANITIZE_NUMBER_FLOAT`	ピリオド (.) を数値の小数点として許可します。
`FILTER_FLAG_ALLOW_THOUSAND`	`FILTER_SANITIZE_NUMBER_FLOAT`, `FILTER_VALIDATE_FLOAT`	カンマ (,) を数値の桁区切り文字として許可します。
`FILTER_FLAG_ALLOW_SCIENTIFIC`	`FILTER_SANITIZE_NUMBER_FLOAT`	e あるいは E を、科学記法の数値として許可します。
`FILTER_FLAG_NO_ENCODE_QUOTES`	`FILTER_SANITIZE_STRING`	このフラグを指定すると、シングルクォート (') およびダブルクォート (") をエンコードしません。
`FILTER_FLAG_ENCODE_LOW`	`FILTER_SANITIZE_ENCODED`, `FILTER_SANITIZE_STRING`, `FILTER_SANITIZE_RAW`	コードが 32 未満のすべての文字をエンコードします。
`FILTER_FLAG_ENCODE_HIGH`	`FILTER_SANITIZE_ENCODED`, `FILTER_SANITIZE_SPECIAL_CHARS`, `FILTER_SANITIZE_STRING`, `FILTER_SANITIZE_RAW`	コードが 127 より大きいすべての文字をエンコードします。
`FILTER_FLAG_ENCODE_AMP`	`FILTER_SANITIZE_STRING`, `FILTER_SANITIZE_RAW`	アンパサンド (&) をエンコードします。
`FILTER_NULL_ON_FAILURE`	`FILTER_VALIDATE_BOOLEAN`	boolean 値として認識できない値の場合に `NULL` を返します。
`FILTER_FLAG_ALLOW_OCTAL`	`FILTER_VALIDATE_INT`	ゼロ (0) で始まる入力を八進数とみなします。ゼロの後には 0-7 しか続けることができません。
`FILTER_FLAG_ALLOW_HEX`	`FILTER_VALIDATE_INT`	0x あるいは 0X で始まる入力を十六進数とみなします。後に続けられる文字は a-fA-F0-9 だけです。
`FILTER_FLAG_EMAIL_UNICODE`	`FILTER_VALIDATE_EMAIL`	Allows the local part of the email address to contain Unicode characters.
`FILTER_FLAG_IPV4`	`FILTER_VALIDATE_IP`	IPv4 形式の IP アドレスを許可します。
`FILTER_FLAG_IPV6`	`FILTER_VALIDATE_IP`	IPv6 形式の IP アドレスを許可します。
`FILTER_FLAG_NO_PRIV_RANGE`	`FILTER_VALIDATE_IP`	IPv4 プライベート領域 10.0.0.0/8, 172.16.0.0/12 および 192.168.0.0/16 を許可しません。 FD あるいは FC ではじまる IPv6 アドレスを許可しません。
`FILTER_FLAG_NO_RES_RANGE`	`FILTER_VALIDATE_IP`	予約済みの IPv4 範囲 0.0.0.0/8, 169.254.0.0/16, 127.0.0.0/8 および 240.0.0.0/4 を許可しません。予約済みの IPv6 範囲 ::1/128、::/128、 ::ffff:0:0/96 および fe80::/10 を許可しません。
`FILTER_FLAG_SCHEME_REQUIRED`	`FILTER_VALIDATE_URL`	URL がスキームを含むことを要求します。
`FILTER_FLAG_HOST_REQUIRED`	`FILTER_VALIDATE_URL`	URL がホストを含むことを要求します。
`FILTER_FLAG_PATH_REQUIRED`	`FILTER_VALIDATE_URL`	URL で、パス部分を必須とします。
`FILTER_FLAG_QUERY_REQUIRED`	`FILTER_VALIDATE_URL`	URL で、クエリ文字列を必須とします。
`FILTER_REQUIRE_SCALAR`		値がスカラーであることを必須とします。
`FILTER_REQUIRE_ARRAY`		値が配列であることを必須とします。
`FILTER_FORCE_ARRAY`		値がスカラーである場合は、スカラー値をひとつだけ持つ配列として扱います。

php filter_var_array() サンプル

<?php
//チェックするデータの配列
$data = array(
	'userId' => 1,
	'name' => 'wepicks taro',
	'mail'=> 'info@wepicks.net',
	'userSummary' => '<html>summary</html>',
);

//チェックする配列データの各キーと適応するフィルタの種類
$args = array(
	'userId' => FILTER_VALIDATE_INT,
	'name' => FILTER_VALIDATE_INT,
	'mail' => FILTER_VALIDATE_EMAIL,
	'userSummary' => FILTER_SANITIZE_ENCODED,
);

//フィルタリング
$myinputs = filter_var_array($data, $args);

//結果
echo '<pre>';
var_dump($myinputs);
echo '</pre>';
?>

<?php

//チェックするデータの配列

$data = array(

'userId' => 1,

'name' => 'wepicks taro',

'mail'=> 'info@wepicks.net',

'userSummary' => '<html>summary</html>',

);

//チェックする配列データの各キーと適応するフィルタの種類

$args = array(

'userId' => FILTER_VALIDATE_INT,

'name' => FILTER_VALIDATE_INT,

'mail' => FILTER_VALIDATE_EMAIL,

'userSummary' => FILTER_SANITIZE_ENCODED,

);

//フィルタリング

$myinputs = filter_var_array($data, $args);

//結果

echo '<pre>';

var_dump($myinputs);

echo '</pre>';

実行結果

array(4) {
["userId"]=>
int(1)
["name"]=>
bool(false)
["mail"]=>
string(16) "info@wepicks.net"
["userSummary"]=>
string(30) "%3Chtml%3Esummary%3C%2Fhtml%3E"
}