PHPのfilter_id()関数の使い方とサンプルコード

PHPのfilter_id()関数は、指定したフィルター名に対応するフィルターIDを取得するための関数です。データ検証やサニタイズを行う際に、フィルター名からIDを動的に取得したい場合に便利です。

構文

filter_id(filtername)

パラメータ

• filtername − IDを取得したいフィルターの名前を指定します。

戻り値

filter_id()関数は、指定されたフィルターが存在する場合はそのフィルターID（整数値）を返します。フィルターが存在しない場合はFALSEを返します。

使用例

以下の例では、filter_list()関数で利用可能なすべてのフィルター名を取得し、それぞれに対応するフィルターIDを出力しています。

<?php
    foreach (filter_list() as $id => $filter) {
        echo $filter . "=" . filter_id($filter) . "<br>";
    }
?>

出力結果

上記のコードを実行すると、以下のような出力が得られます。

int = 257
boolean = 258
float = 259
validate_regexp = 272
validate_domain = 277
validate_url = 273
validate_email = 274
validate_ip = 275
validate_mac = 276
string = 513
stripped = 513
encoded = 514
special_chars = 515
full_special_chars = 522
unsafe_raw = 516
email = 517
url = 518
number_int = 519
number_float = 520
magic_quotes = 521
callback = 1024

補足ポイント

• filter_id()は主に、ユーザー入力や設定ファイルから受け取ったフィルター名を、filter_var()やfilter_input()で使えるIDに変換したい場合に活用されます。

• 存在しないフィルター名を指定するとFALSEが返るため、実行前に戻り値のチェックを行うと安全です。

• 逆に、フィルターIDからフィルター名を取得したい場合はfilter_list()と組み合わせて利用します。