ホーム > PHP関数リファレンス > フィルタ系 > php filter_list フィルタ一覧を取得する

php filter_list フィルタ一覧を取得する

PHP5 PHP7

php filter_list フィルタ一覧を取得する

◆ php filter_list() 内容

◆ php filter_list() パラメーター

◆ php filter_list() 返り値

◆ php filter_list() 変更履歴

◆ 検証用フィルタ

◆ 除去用フィルタ

◆ フィルタフラグ

php filter_list() サンプル

php filter_list フィルタ一覧を取得する

php filter_list() 書式
array フィルタ一覧の配列 = filter_list(void);

説明	現在のPHPスクリプトがサポートしているフィルタ一覧を配列として取得します。
返り値	array	フィルタ一覧の配列を返します。フィルタが無い場合、空の配列を返します。

サンプル

<?php
echo '<pre>';
var_dump(filter_list());
echo '</pre>';
?>

<?php

echo '<pre>';

var_dump(filter_list());

echo '</pre>';

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

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

引数や返り値	内容（引数 \| 返り値）
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_list() 内容

フィルタ一覧を返す

現在のPHPスクリプトがサポートしているフィルタ一覧を配列として取得します。フィルタが存在しない場合、返り値の配列は空となります。取得した配列はキーが数値のインデックス配列（キーが文字列なのは連想配列）です。配列のキーの数値はフィルタのIDではありません。フィルタのIDを取得するには、filter_id()関数を使用します。

◆ php filter_list() パラメーター

値	内容
–	–

◆ php filter_list() 返り値

array
フィルタ一覧の配列を返します。フィルタが無い場合、空の配列を返します。

array 配列型を返します。

◆ php filter_list() 変更履歴

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_list() サンプル

フィルタ一覧

<?php
echo '<pre>';
var_dump(filter_list());
echo '</pre>';
?>

<?php

echo '<pre>';

var_dump(filter_list());

echo '</pre>';

実行結果

array(21) {
[0]=>
string(3) "int"
[1]=>
string(7) "boolean"
[2]=>
string(5) "float"
[3]=>
string(15) "validate_regexp"
[4]=>
string(15) "validate_domain"
[5]=>
string(12) "validate_url"
[6]=>
string(14) "validate_email"
[7]=>
string(11) "validate_ip"
[8]=>
string(12) "validate_mac"
[9]=>
string(6) "string"
[10]=>
string(8) "stripped"
[11]=>
string(7) "encoded"
[12]=>
string(13) "special_chars"
[13]=>
string(18) "full_special_chars"
[14]=>
string(10) "unsafe_raw"
[15]=>
string(5) "email"
[16]=>
string(3) "url"
[17]=>
string(10) "number_int"
[18]=>
string(12) "number_float"
[19]=>
string(12) "magic_quotes"
[20]=>
string(8) "callback"
}

フィルタ名とフィルタIDを取得

<?php 
$aFilters = filter_list(); //利用可能なフィルタ名一覧を配列で返す
foreach($aFilters as $sFilterName) { 
	echo "フィルタ名：[".$sFilterName."] － フィルタID：[".filter_id($sFilterName)."]<br>\n";
}
?>

<?php

$aFilters = filter_list(); //利用可能なフィルタ名一覧を配列で返す

foreach($aFilters as $sFilterName) {

echo "フィルタ名：[".$sFilterName."] －フィルタID：[".filter_id($sFilterName)."]<br>\n";

}

実行結果

フィルタ名：[int] －フィルタID：[257]
フィルタ名：[boolean] －フィルタID：[258]
フィルタ名：[float] －フィルタID：[259]
フィルタ名：[validate_regexp] －フィルタID：[272]
フィルタ名：[validate_domain] －フィルタID：[277]
フィルタ名：[validate_url] －フィルタID：[273]
フィルタ名：[validate_email] －フィルタID：[274]
フィルタ名：[validate_ip] －フィルタID：[275]
フィルタ名：[validate_mac] －フィルタID：[276]
フィルタ名：[string] －フィルタID：[513]
フィルタ名：[stripped] －フィルタID：[513]
フィルタ名：[encoded] －フィルタID：[514]
フィルタ名：[special_chars] －フィルタID：[515]
フィルタ名：[full_special_chars] －フィルタID：[522]
フィルタ名：[unsafe_raw] －フィルタID：[516]
フィルタ名：[email] －フィルタID：[517]
フィルタ名：[url] －フィルタID：[518]
フィルタ名：[number_int] －フィルタID：[519]
フィルタ名：[number_float] －フィルタID：[520]
フィルタ名：[magic_quotes] －フィルタID：[521]
フィルタ名：[callback] －フィルタID：[1024]