【PHP8.x】FILTER_VALIDATE_IP定数の使い方

Copy
1<?php
2
3/**
4 * IPアドレス文字列の有効性を検証する関数です。
5 * PHPのFILTER_VALIDATE_IP定数を使用して、IPv4およびIPv6アドレスの検証方法を示します。
6 *
7 * FILTER_VALIDATE_IPは、filter_var()関数で使用されるフィルタ定数です。
8 * この定数自体には引数や戻り値はありませんが、filter_var()関数の第2引数として渡すことで、
9 * 指定された文字列が有効なIPアドレス形式であるかをチェックします。
10 */
11function validateIpAddresses(): void
12{
13    // 検証する様々なIPアドレスの例
14    $ipAddresses = [
15        '有効なIPv4' => '192.168.1.1',
16        '無効なIPv4' => '192.168.1.256', // 255を超える数値
17        '有効なIPv6' => '2001:0db8:85a3:0000:0000:8a2e:0370:7334',
18        '有効なIPv6 (短縮形)' => '::1', // localhostのIPv6アドレス
19        '無効なIPv6' => '2001:0db8::fg', // 不正な文字が含まれる
20        'IPではない文字列' => 'Hello World',
21    ];
22
23    echo "--- IPアドレス検証の開始 ---\n\n";
24
25    foreach ($ipAddresses as $description => $ip) {
26        echo "検証対象: '{$ip}' ({$description})\n";
27
28        // 1. FILTER_VALIDATE_IP を用いた一般的なIPアドレス検証
29        // IPv4とIPv6の両方に対応しています。
30        if (filter_var($ip, FILTER_VALIDATE_IP)) {
31            echo "  - FILTER_VALIDATE_IP (一般): 有効なIPアドレスです。\n";
32        } else {
33            echo "  - FILTER_VALIDATE_IP (一般): 無効なIPアドレスです。\n";
34        }
35
36        // 2. FILTER_FLAG_IPV4 オプションを用いたIPv4限定検証
37        // 第3引数にオプションを指定することで、特定のIPバージョンのみを検証できます。
38        if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
39            echo "  - FILTER_FLAG_IPV4 (IPv4限定): 有効なIPv4アドレスです。\n";
40        } else {
41            echo "  - FILTER_FLAG_IPV4 (IPv4限定): 無効なIPv4アドレスまたはIPv6アドレスです。\n";
42        }
43
44        // 3. FILTER_FLAG_IPV6 オプションを用いたIPv6限定検証
45        // IPv6アドレスのみを検証する場合に使用します。
46        if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
47            echo "  - FILTER_FLAG_IPV6 (IPv6限定): 有効なIPv6アドレスです。\n";
48        } else {
49            echo "  - FILTER_FLAG_IPV6 (IPv6限定): 無効なIPv6アドレスまたはIPv4アドレスです。\n";
50        }
51        echo "\n";
52    }
53
54    echo "--- IPアドレス検証の終了 ---\n";
55}
56
57// 関数を実行してIPアドレスを検証します。
58validateIpAddresses();

PHPのFILTER_VALIDATE_IPは、入力された文字列が有効なIPアドレスであるかを検証するために使用される定数です。この定数自体には引数や戻り値はありませんが、主にfilter_var()関数と組み合わせて利用されます。filter_var()関数の第2引数にFILTER_VALIDATE_IPを渡すことで、指定された文字列が適切なIPアドレス形式かどうかをチェックできます。

filter_var()関数は、検証に成功した場合は入力されたIPアドレス文字列をそのまま返し、無効な場合はfalseを返します。これにより、コード内でIPアドレスの有効性を簡単に判定することが可能です。FILTER_VALIDATE_IPは、IPv4アドレスとIPv6アドレスの両方の形式に対応しており、どちらのタイプのIPアドレスも検証できます。

さらに、filter_var()関数の第3引数にオプションを指定することで、検証の範囲を限定できます。例えば、FILTER_FLAG_IPV4オプションを使用するとIPv4アドレスのみを、FILTER_FLAG_IPV6オプションを使用するとIPv6アドレスのみを検証するようになります。サンプルコードでは、これらの使い方を複数のIPアドレス例を通して具体的に示し、それぞれの定数やオプションがどのように機能するかを理解できるようになっています。

Copy
1<?php
2
3/**
4 * 指定された文字列が有効なIPアドレス（IPv4またはIPv6）であるか検証します。
5 *
6 * PHPのFILTER_VALIDATE_IP定数とfilter_var関数を使用し、IPアドレスの妥当性を確認します。
7 * FILTER_VALIDATE_IP定数は、IPv4およびIPv6アドレスの書式を検証するために利用されます。
8 *
9 * @param string $ipAddress 検証対象のIPアドレス文字列。
10 * @return bool 有効なIPアドレスであれば true、無効であれば false を返します。
11 */
12function validateIpAddress(string $ipAddress): bool
13{
14    // filter_var関数は、指定された値が特定のフィルタの条件を満たす場合にフィルタリングされた値を返し、
15    // 満たさない場合は false を返します。
16    // そのため、結果が false でなければ有効なIPアドレスと判断できます。
17    return filter_var($ipAddress, FILTER_VALIDATE_IP) !== false;
18}
19
20// --- サンプル使用例 ---
21
22echo "--- IPアドレス検証の例 ---" . PHP_EOL;
23
24// 例1: 有効なIPv4アドレス
25$ipv4_valid = "192.168.1.100";
26echo "IPアドレス '{$ipv4_valid}' は " . (validateIpAddress($ipv4_valid) ? "有効" : "無効") . " です。" . PHP_EOL;
27
28// 例2: 無効なIPv4アドレス (オクテットが255を超える)
29$ipv4_invalid = "192.168.1.256";
30echo "IPアドレス '{$ipv4_invalid}' は " . (validateIpAddress($ipv4_invalid) ? "有効" : "無効") . " です。" . PHP_EOL;
31
32// 例3: 有効なIPv6アドレス
33$ipv6_valid = "2001:0db8:85a3:0000:0000:8a2e:0370:7334";
34echo "IPアドレス '{$ipv6_valid}' は " . (validateIpAddress($ipv6_valid) ? "有効" : "無効") . " です。" . PHP_EOL;
35
36// 例4: 無効な形式の文字列
37$not_an_ip = "これはIPアドレスではありません";
38echo "文字列 '{$not_an_ip}' は " . (validateIpAddress($not_an_ip) ? "有効" : "無効") . " です。" . PHP_EOL;
39
40echo "-------------------------" . PHP_EOL;
41
42?>

このPHPコードは、指定された文字列が有効なIPアドレス（IPv4またはIPv6）の形式を満たしているかを検証する方法を示しています。FILTER_VALIDATE_IPはPHPに組み込まれている定数で、IPアドレスの書式が正しいかをチェックするためのフィルターを指定する際に使用します。この定数は、主にfilter_var関数と一緒に利用されます。

filter_var関数は、第一引数に検証したい文字列を、第二引数にFILTER_VALIDATE_IPのようなフィルターの種類を渡します。検証に成功した場合、filter_var関数はフィルタリングされた値を返し、書式が正しくないなど検証に失敗した場合はfalseを返します。

サンプルコードのvalidateIpAddress関数は、検証対象となるIPアドレスの文字列を$ipAddress引数として受け取ります。そして、filter_var関数を使ってその文字列を検証し、結果がfalseでなければ有効なIPアドレスと判断してtrueを、falseであれば無効なIPアドレスと判断してfalseを戻り値として返します。これにより、プログラムはユーザー入力などのIPアドレスの妥当性を簡単に確認できるようになります。例では、有効なIPアドレスと無効なIPアドレスのそれぞれで検証結果が示されており、この機能がウェブアプリケーションにおけるセキュリティやデータ整合性の向上に役立つことが分かります。