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

Copy
1<?php
2
3/**
4 * PHP_URL_QUERY 定数を使用してURLからクエリ部分を抽出する例。
5 *
6 * PHP_URL_QUERY は parse_url() 関数で使用される定数で、
7 * URLのクエリ部分 (例: ?id=123&name=test の '?id=123&name=test' 部分) を取得します。
8 * 抽出したクエリ文字列は、parse_str() 関数で連想配列に変換できます。
9 */
10function extractUrlQueryExample(): void
11{
12    // 解析対象のサンプルURL
13    $url = 'https://www.example.com/path/to/page?product_id=123&category=electronics&sort=price_asc';
14
15    echo "元のURL: " . $url . PHP_EOL . PHP_EOL;
16
17    // parse_url() 関数と PHP_URL_QUERY 定数を使用して、URLのクエリ部分を抽出します。
18    // PHP_URL_QUERY は、URLの '?' 以降の文字列を指す組み込み定数です。
19    $query = parse_url($url, PHP_URL_QUERY);
20
21    if ($query !== false && $query !== null) {
22        echo "抽出されたクエリ文字列: " . $query . PHP_EOL . PHP_EOL;
23
24        // 抽出したクエリ文字列をさらに解析し、連想配列に変換します。
25        // parse_str() 関数は、クエリ文字列をキーと値のペアの配列に解析します。
26        parse_str($query, $queryParams);
27
28        echo "解析されたクエリパラメータ:" . PHP_EOL;
29        print_r($queryParams);
30    } else {
31        echo "URLにクエリ部分が見つかりませんでした。" . PHP_EOL;
32    }
33}
34
35// 関数を実行して、URLクエリの抽出と解析の例を表示します。
36extractUrlQueryExample();

PHPのPHP_URL_QUERYは、URL（Uniform Resource Locator）から特定の情報、特に「クエリ部分」を抽出するためにparse_url()関数と組み合わせて使用される組み込み定数です。クエリ部分とは、URLの「?」記号以降に続く「キー=値」形式のパラメータ群（例：?id=123&name=test）を指します。この定数自体は引数や戻り値を持たず、parse_url()関数の第二引数として渡すことで、目的の要素抽出を指示します。

サンプルコードでは、まず対象のURLが定義されています。次に、parse_url()関数にこのURLとPHP_URL_QUERY定数を渡すことで、URLからクエリ文字列全体を抽出しています。parse_url()関数は、指定された要素が見つかればその文字列を返し、見つからない場合はfalseまたはnullを返します。

抽出されたクエリ文字列は、さらにparse_str()関数によって個々のパラメータに分解されます。parse_str()関数は、第一引数にクエリ文字列を、第二引数に結果を格納するための配列変数を参照渡しで受け取り、クエリ文字列をキーと値のペアを持つ連想配列に変換します。これにより、URL内のproduct_idやcategoryといった各パラメータに簡単にアクセスし、プログラムで利用できるようになります。これらの機能は、WebアプリケーションでURLパラメータを処理する際によく利用されます。

Copy
1<?php
2
3/**
4 * URLからパスとクエリ部分を抽出する例を示します。
5 *
6 * PHP_URL_QUERYとPHP_URL_PATHは、parse_url()関数と組み合わせて
7 * URLの特定の部分を抽出するために使用される定数です。
8 */
9function demonstrateUrlParsing(): void
10{
11    // 解析対象のURLを定義します。
12    // このURLにはパス(/articles/php)とクエリ(?id=123&category=web)が含まれています。
13    $url = 'https://www.example.com/articles/php?id=123&category=web#section1';
14
15    echo "対象URL: " . $url . "\n\n";
16
17    // PHP_URL_QUERY定数を使用して、URLからクエリ文字列部分を抽出します。
18    // クエリ文字列は '?' 以降の部分です。
19    $query = parse_url($url, PHP_URL_QUERY);
20
21    // 抽出したクエリ部分を出力します。
22    if ($query !== false && $query !== null) {
23        echo "抽出されたクエリ部分 (PHP_URL_QUERY): " . $query . "\n";
24    } else {
25        echo "クエリ部分が見つかりませんでした。\n";
26    }
27
28    // PHP_URL_PATH定数を使用して、URLからパス部分を抽出します。
29    // パスはドメイン名の後、'?' または '#' の前の部分です。
30    $path = parse_url($url, PHP_URL_PATH);
31
32    // 抽出したパス部分を出力します。
33    if ($path !== false && $path !== null) {
34        echo "抽出されたパス部分 (PHP_URL_PATH): " . $path . "\n";
35    } else {
36        echo "パス部分が見つかりませんでした。\n";
37    }
38}
39
40// 関数を実行して、URLの解析結果を表示します。
41demonstrateUrlParsing();

このPHPサンプルコードは、URLから特定の要素、具体的にはパスとクエリ文字列を抽出する方法を示しています。ここで使用されているPHP_URL_QUERYとPHP_URL_PATHは、PHPの標準関数であるparse_url()と組み合わせて使う「定数」です。これらは、parse_url()関数にどの部分を抽出してほしいかを指示するために利用されます。

PHP_URL_QUERYは、URL内のクエリ文字列部分を指し示します。クエリ文字列とは、URLの?記号の後に続く部分で、通常はkey=valueの形式で情報が渡される部分です（例：?id=123&category=web）。この定数自体に引数はなく、特定の値を返すわけではありませんが、parse_url()関数の第二引数として渡すことで、指定されたURLからクエリ文字列が抽出され、関数の戻り値として文字列で返されます。

同様に、PHP_URL_PATHはURLのパス部分を指します。パスとは、ドメイン名の後から?または#記号の前の部分です（例：/articles/php）。この定数も引数を持たず、parse_url()に渡すことでパスが抽出されます。

サンプルコードでは、まず定義されたURLに対し、parse_url()関数とこれらの定数を使って、クエリ部分とパス部分をそれぞれ抽出しています。抽出が成功した場合、その内容が出力され、該当する部分がURLに存在しない場合はその旨が表示されるため、URL解析の基本的な処理を理解するのに役立ちます。