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

Copy
1<?php
2
3/**
4 * このスクリプトは、指定されたURLのHTTPヘッダー情報を取得し、表示する方法を示します。
5 * get_headers() 関数は、Webサーバーからのレスポンスヘッダーを配列として返します。
6 *
7 * システムエンジニアを目指す初心者が、Webサイトとの基本的なやり取り（ヘッダー情報の取得）
8 * を理解するのに役立ちます。
9 */
10
11// ヘッダーを取得するターゲットURLを定義します。
12// 実際に存在するWebサイトのURLを使用してください。
13const TARGET_URL = 'https://www.example.com';
14
15echo "--- " . TARGET_URL . " からのHTTPヘッダーの取得 ---" . PHP_EOL . PHP_EOL;
16
17// 1. デフォルトモード（数値添字配列）でヘッダーを取得する
18// get_headers() の第2引数 ($associative) を false（デフォルト値）に設定すると、
19// 各ヘッダー行全体が配列の要素として返されます。
20$indexedHeaders = get_headers(TARGET_URL);
21
22if ($indexedHeaders === false) {
23    // ヘッダーの取得に失敗した場合のエラー処理
24    echo "エラー: " . TARGET_URL . " からヘッダーを取得できませんでした。" . PHP_EOL;
25} else {
26    echo "--- 数値添字配列形式のヘッダー ---" . PHP_EOL;
27    foreach ($indexedHeaders as $header) {
28        echo $header . PHP_EOL;
29    }
30    echo PHP_EOL;
31}
32
33// 2. 連想配列モードでヘッダーを取得する
34// get_headers() の第2引数 ($associative) を true に設定すると、
35// ヘッダー名が配列のキーとなり、ヘッダー値が要素となります。
36// 同じ名前のヘッダーが複数ある場合（例: Set-Cookie）、通常は最初のヘッダーのみが保持されます。
37$associativeHeaders = get_headers(TARGET_URL, true);
38
39if ($associativeHeaders === false) {
40    // ヘッダーの取得に失敗した場合のエラー処理
41    echo "エラー: " . TARGET_URL . " から連想配列形式のヘッダーを取得できませんでした。" . PHP_EOL;
42} else {
43    echo "--- 連想配列形式のヘッダー ---" . PHP_EOL;
44    foreach ($associativeHeaders as $name => $value) {
45        echo "$name: $value" . PHP_EOL;
46    }
47    echo PHP_EOL;
48}
49
50?>

PHPのget_headers関数は、指定されたURLのHTTPヘッダー情報を取得するために使用されます。Webサーバーからのレスポンスヘッダーを配列として返し、Webサイトとの基本的なやり取りにおいて、どのような情報が送受信されているかを知る上で非常に役立ちます。

この関数は、最初の引数$urlにヘッダーを取得したいWebサイトのURLを指定します。オプションの第2引数$associativeは、戻り値の配列の形式を制御します。これをfalse（デフォルト）に設定すると、各ヘッダー行全体が数値添字配列の要素として返されます。一方、trueに設定すると、ヘッダー名が配列のキーとなり、ヘッダー値が要素となる連想配列形式で取得できます。

関数が成功するとHTTPヘッダーの配列を返しますが、何らかの理由でヘッダーの取得に失敗した場合はfalseを返します。サンプルコードでは、このget_headers関数を使い、デフォルトの数値添字配列形式と、$associative引数をtrueにした連想配列形式の両方でヘッダー情報を取得し、表示する方法を示しています。これにより、Webサーバーが提供する情報を効率的に確認できます。

Copy
1<?php
2
3/**
4 * 指定されたURLへPOSTリクエストを送信し、そのレスポンスヘッダを取得する関数。
5 *
6 * get_headers() 関数は、デフォルトではGETリクエストを送信してリモートサーバからの
7 * レスポンスヘッダを取得します。POSTリクエストを送信するには、ストリームコンテキスト
8 * (stream context) を使用してHTTPメソッドとPOSTデータを設定する必要があります。
9 *
10 * @param string $url POSTリクエストを送信するターゲットURL。
11 * @param array $postData POSTリクエストのボディに含めるデータ (連想配列)。
12 * @return array|false レスポンスヘッダの連想配列、または失敗した場合はfalse。
13 */
14function getHeadersFromPostRequest(string $url, array $postData): array|false
15{
16    // POSTデータを 'key=value&key2=value2' の形式にエンコードします。
17    $content = http_build_query($postData);
18
19    // ストリームコンテキストのオプションを設定します。
20    // 'http' キーの下に、HTTPリクエストに関する設定を記述します。
21    $options = [
22        'http' => [
23            // リクエストメソッドを 'POST' に設定します。
24            'method'  => 'POST',
25            // ヘッダを設定します。Content-typeはPOSTデータの形式を示し、
26            // Content-Lengthはボディのバイト数を示します。
27            'header'  => [
28                'Content-type: application/x-www-form-urlencoded',
29                'Content-Length: ' . strlen($content),
30            ],
31            // POSTリクエストのボディとしてエンコードしたデータを設定します。
32            'content' => $content,
33            // SSL/TLS証明書の検証を無効にする場合は以下を設定しますが、
34            // 本番環境では推奨されません。テスト目的で使用することがあります。
35            // 'verify_peer' => false,
36            // 'verify_peer_name' => false,
37        ],
38    ];
39
40    // 設定したオプションでストリームコンテキストを作成します。
41    $context = stream_context_create($options);
42
43    // get_headers() 関数を使用して、指定されたURLへPOSTリクエストを送信し、
44    // その応答として返されるヘッダを取得します。
45    // 第二引数に true を渡すと、ヘッダが連想配列 (ヘッダ名 => 値) で返されます。
46    // 第三引数に作成したコンテキストを渡すことで、POSTリクエストが実行されます。
47    $headers = get_headers($url, true, $context);
48
49    return $headers;
50}
51
52// --- 使用例 ---
53// httpbin.org/post は、受け取ったPOSTリクエストの情報をそのまま返す
54// テスト用のエンドポイントです。この例では、httpbin.org/post にPOSTリクエストを送り、
55// そのサーバからのレスポンスヘッダを取得します。
56$targetUrl = 'http://httpbin.org/post';
57$dataToSend = [
58    'username' => 'php_user',
59    'message'  => 'Hello from PHP get_headers!',
60];
61
62echo "ターゲットURL: " . $targetUrl . "\n";
63echo "送信データ: " . json_encode($dataToSend) . "\n\n";
64
65// 関数を呼び出してPOSTリクエストのレスポンスヘッダを取得します。
66$responseHeaders = getHeadersFromPostRequest($targetUrl, $dataToSend);
67
68if ($responseHeaders !== false) {
69    echo "--- レスポンスヘッダ ---" . "\n";
70    foreach ($responseHeaders as $name => $value) {
71        // 一部のヘッダ（例: Set-Cookie）は複数の値を持つことがあるため、配列として処理します。
72        if (is_array($value)) {
73            foreach ($value as $val) {
74                echo $name . ": " . $val . "\n";
75            }
76        } else {
77            echo $name . ": " . $value . "\n";
78        }
79    }
80} else {
81    echo "エラー: ヘッダの取得に失敗しました。URLまたはネットワーク接続を確認してください。\n";
82}

PHPのget_headers関数は、指定されたURLのリモートサーバからHTTPレスポンスヘッダを取得するために使用されます。通常はGETリクエストを送信しますが、ストリームコンテキストを利用することでPOSTリクエストも実行可能です。

サンプルコードでは、getHeadersFromPostRequest関数がPOSTリクエストによるヘッダ取得をカプセル化しています。まず、http_build_queryでPOSTデータをURLエンコードし、次にstream_context_create関数を使ってHTTPメソッドをPOSTに、ヘッダにContent-typeやContent-Lengthを、そしてボディにエンコード済みデータを設定します。このコンテキストをget_headers関数の第三引数として渡すことで、POSTリクエストが実行されます。

get_headers関数の第一引数にはターゲットURLを指定します。第二引数にtrueを渡すと、ヘッダがヘッダ名と値の連想配列として返されます。第三引数には、POSTリクエストの詳細を設定したストリームコンテキストを渡します。戻り値は取得したヘッダ情報の配列、または失敗した場合はfalseとなります。この仕組みにより、クライアントはサーバーからのレスポンスヘッダを柔軟に取得できます。