【PHP8.x】parse_url関数の使い方

Copy
1<?php
2declare(strict_types=1);
3
4/**
5 * URL文字列からクエリパラメータを連想配列として抽出します。
6 *
7 * この関数は、指定されたURLを解析し、その中のクエリ文字列（例: `?key1=value1&key2=value2`）
8 * をキーと値のペアからなる連想配列に変換して返します。
9 *
10 * @param string $url 解析対象のURL。
11 * @return array クエリパラメータを格納した連想配列。クエリが存在しない場合は空の配列を返します。
12 */
13function getQueryParameters(string $url): array
14{
15    // URLからクエリ文字列部分 ('?' 以降) を取得します。
16    // クエリが存在しない場合、parse_urlは null を返します。
17    $queryString = parse_url($url, PHP_URL_QUERY);
18
19    // クエリ文字列が取得できなかった場合は、空の配列を返します。
20    if ($queryString === null || $queryString === '') {
21        return [];
22    }
23
24    // クエリ文字列を解析し、連想配列に変換します。
25    // 第2引数に渡した変数に、解析結果が格納されます。
26    parse_str($queryString, $queryParams);
27
28    return $queryParams;
29}
30
31// --- 実行例 ---
32
33// 解析したいURL文字列
34$sampleUrl = 'https://www.example.com/products?category=books&id=123&lang=ja';
35
36// 関数を呼び出してクエリパラメータを取得
37$parameters = getQueryParameters($sampleUrl);
38
39// 結果を画面に出力して確認
40// 以下のような出力が期待されます:
41// Array
42// (
43//     [category] => books
44//     [id] => 123
45//     [lang] => ja
46// )
47print_r($parameters);
48
49// クエリがないURLの場合
50$urlWithoutQuery = 'https://www.example.com/about';
51$parametersWithoutQuery = getQueryParameters($urlWithoutQuery);
52
53// 空の配列が出力されます
54print_r($parametersWithoutQuery);

このPHPコードは、URL文字列からクエリパラメータ（URLの?以降の部分）を抽出し、扱いやすい連想配列の形式に変換する方法を示しています。

中心的な役割を担うのはparse_url関数です。この関数は、第1引数に渡されたURL文字列を、その構成要素（スキーム、ホスト、パス、クエリなど）に分解します。サンプルコードでは、第2引数に定数PHP_URL_QUERYを指定しています。これにより、URL全体からクエリ文字列（例：category=books&id=123）の部分だけを正確に取り出すことができます。もし指定されたURLにクエリ文字列が存在しない場合、この関数はnullを返します。

次に、取得したクエリ文字列をキーと値のペアを持つ連想配列に変換するため、parse_str関数を使用します。この関数は、第1引数にクエリ文字列を、第2引数に結果を格納するための変数を渡します。すると、&で区切られた文字列が解析され、指定した変数の中に連想配列が作成されます。

このように2つの関数を組み合わせることで、任意のURLからクエリパラメータを連想配列として安全かつ簡単に取得できます。クエリが存在しないURLを渡した場合は、空の配列が返されます。

Copy
1<?php
2
3/**
4 * URLを解析し、その構成要素（スキーマ、ホスト、パスなど）を取得する
5 * parse_url関数の基本的な使用例を示します。
6 *
7 * @param string $url 解析対象のURL
8 * @return void
9 */
10function parseUrlExample(string $url): void
11{
12    echo "--- URLの解析を開始 --- \n";
13    echo "解析対象URL: " . $url . "\n\n";
14
15    // 1. URL全体を解析し、すべてのコンポーネントを連想配列として取得します。
16    //    解析に失敗した場合（無効なURLなど）は false が返されます。
17    $components = parse_url($url);
18
19    if ($components === false) {
20        echo "エラー: URLの解析に失敗しました。無効なURL形式の可能性があります。\n\n";
21        return;
22    }
23
24    echo "--- 全コンポーネントの取得結果 ---\n";
25    // print_r関数は、配列の構造を人間が読める形式で表示するのに便利です。
26    print_r($components);
27    echo "\n";
28
29    // 2. 特定のURLコンポーネントのみを取得します。
30    //    parse_url関数の第二引数に以下の定数を指定できます:
31    //    PHP_URL_SCHEME, PHP_URL_HOST, PHP_URL_PORT, PHP_URL_USER,
32    //    PHP_URL_PASS, PHP_URL_PATH, PHP_URL_QUERY, PHP_URL_FRAGMENT
33    $scheme = parse_url($url, PHP_URL_SCHEME);
34    $host = parse_url($url, PHP_URL_HOST);
35    $port = parse_url($url, PHP_URL_PORT);
36    $path = parse_url($url, PHP_URL_PATH);
37    $query = parse_url($url, PHP_URL_QUERY);
38    $fragment = parse_url($url, PHP_URL_FRAGMENT);
39
40    echo "--- 特定コンポーネントの取得結果 ---\n";
41    // コンポーネントが存在しない場合、parse_urlは null を返します。
42    // ?? 'N/A' を使用して、null の場合に 'N/A' と表示するようにします。
43    echo "  Scheme (スキーマ):     " . ($scheme ?? 'N/A') . "\n";
44    echo "  Host (ホスト):       " . ($host ?? 'N/A') . "\n";
45    echo "  Port (ポート):       " . ($port ?? 'N/A') . "\n";
46    echo "  Path (パス):         " . ($path ?? 'N/A') . "\n";
47    echo "  Query (クエリ):      " . ($query ?? 'N/A') . "\n";
48    echo "  Fragment (フラグメント): " . ($fragment ?? 'N/A') . "\n";
49    echo "\n";
50}
51
52// サンプルURLで関数を実行します。
53// 様々なURL形式を試すために、複数のURLを用意しました。
54
55// 完全なURLの例
56$sampleUrl1 = "https://user:pass@www.example.com:8080/path/to/page.php?id=123&name=test#section";
57parseUrlExample($sampleUrl1);
58
59// シンプルなURLの例 (ポート、ユーザー、パスワード、クエリ、フラグメントなし)
60$sampleUrl2 = "http://localhost/index.html";
61parseUrlExample($sampleUrl2);
62
63// スキーマやホストがない相対パスの例 (一部のコンポーネントは取得できません)
64$sampleUrl3 = "/relative/path/file.php?param=value";
65parseUrlExample($sampleUrl3);
66
67// 無効なURL文字列の例 (parse_urlはfalseを返します)
68$sampleUrl4 = "これは有効なURLではありません";
69parseUrlExample($sampleUrl4);
70
71?>

このPHPサンプルコードは、parse_url関数の使い方を説明するものです。この関数は、URL文字列を解析し、スキーマ（http, httpsなど）、ホスト名、パスといった構成要素に分解する機能を提供します。

第一引数には、解析したいURL文字列を渡します。第二引数は省略可能で、指定すると特定の要素だけを取り出せます。

第二引数を省略して呼び出した場合、戻り値はURLの各要素をキーに持つ連想配列になります。例えば、$components['host'] のようにしてホスト名を取得できます。もし渡されたURLの形式が正しくなく解析に失敗した場合は false が返されます。

第二引数に PHP_URL_SCHEME や PHP_URL_HOST のような定数を指定すると、対応する要素の文字列や数値が直接返されます。もし指定した要素がURLに含まれていない場合は null が返ります。

このサンプルコードでは、いくつかの異なる形式のURLを parse_url 関数で解析し、その結果を表示することで、引数の渡し方による戻り値の違いや、URLの形式によって取得できる情報がどのように変わるかを具体的に示しています。