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

Copy
1<?php
2
3/**
4 * PHPスクリプトが送信する予定、またはすでに送信したHTTPレスポンスヘッダーの一覧を表示します。
5 * `header()`関数でヘッダーを設定した後、`headers_list()`を呼び出すと、
6 * その設定されたヘッダーがリストに含まれることを確認できます。
7 */
8
9// Content-Type ヘッダーを設定します。
10header('Content-Type: text/plain; charset=utf-8');
11
12// カスタムヘッダーを設定します。
13header('X-Custom-Header: PHP-Example-Value');
14
15// 期限切れのキャッシュ制御ヘッダーを設定します。（例として）
16header('Cache-Control: no-cache, no-store, must-revalidate');
17header('Pragma: no-cache');
18header('Expires: 0');
19
20// 現在設定されているすべてのHTTPレスポンスヘッダーを取得します。
21$allHeaders = headers_list();
22
23// 取得したヘッダーの配列を整形して出力します。
24echo "現在設定されているHTTPレスポンスヘッダーの一覧:\n";
25print_r($allHeaders);
26
27// 注意: このスクリプトはウェブサーバー経由で実行すると、
28// 実際のHTTPレスポンスヘッダーとしてこれらの情報が送信されます。
29// コマンドラインから実行した場合（例: php your_script.php）は、
30// ヘッダーは実際には送信されませんが、`headers_list()`は設定されたヘッダーを返します。
31?>

headers_list関数は、PHPスクリプトがウェブブラウザなどのクライアントに送信するHTTPレスポンスヘッダーの一覧を取得するために使用する関数です。この関数は引数をとりません。戻り値として、現在PHPスクリプトによって設定されているすべてのHTTPレスポンスヘッダーを文字列の配列として返します。

サンプルコードでは、まずheader()関数を使ってContent-Type、X-Custom-Header、そしてキャッシュ制御に関する複数のHTTPヘッダーを設定しています。これらのヘッダーは、ウェブページの種類や追加情報、キャッシュの扱いなどをクライアントに伝える役割があります。次に、headers_list()関数を呼び出すことで、これらの設定されたすべてのヘッダーが配列として変数$allHeadersに格納されます。最後に、print_r()関数を使って、取得したヘッダーの配列の内容を整形して画面に出力しています。

これにより、スクリプトがどのようなHTTPヘッダーを送信する予定であるか、またはすでに送信したかを確認できます。ウェブサーバー経由でこのスクリプトを実行した場合、設定したヘッダーは実際にHTTPレスポンスの一部としてクライアントに送信されます。コマンドラインから実行した場合は、ヘッダーは実際に送信されませんが、headers_list()は設定されたヘッダー情報を正確に返しますので、デバッグやヘッダー内容の確認に役立ちます。

Copy
1<?php
2
3/**
4 * このスクリプトがクライアントに送信するHTTPレスポンスヘッダーを設定します。
5 * headers_list() 関数は、これらの設定されたヘッダーを取得するために使用されます。
6 */
7header('Content-Type: text/plain; charset=utf-8');
8header('X-App-Name: MySimpleApp');
9header('Cache-Control: no-cache, no-store, must-revalidate');
10
11/**
12 * 現在設定されているすべてのHTTPレスポンスヘッダーのリストを取得します。
13 * これは、このPHPスクリプトがブラウザなどのクライアントに送信するヘッダーです。
14 *
15 * 注意: この関数は、ブラウザからサーバーに送られたリクエストヘッダーではなく、
16 * PHPスクリプトが設定したレスポンスヘッダーを返します。
17 * リクエストヘッダーを取得するには、通常 $_SERVER スーパーグローバル変数や getallheaders() 関数を使用します。
18 */
19$responseHeaders = headers_list();
20
21// 取得したレスポンスヘッダーを整形して表示します。
22echo "現在設定されているHTTPレスポンスヘッダーのリスト:\n";
23print_r($responseHeaders);
24
25?>

PHPのheaders_list関数は、PHPスクリプトがWebブラウザなどのクライアントに送信するHTTPレスポンスヘッダーのリストを取得するために使用されます。この関数は引数を持ちませんが、現在設定されているすべてのレスポンスヘッダーを文字列の配列（array）として返します。

サンプルコードでは、最初にheader()関数を用いて「Content-Type」や「X-App-Name」といったHTTPレスポンスヘッダーを設定しています。これらのヘッダーは、PHPスクリプトの実行が完了した際にクライアントへ送られる情報です。

その後、headers_list()関数を呼び出すことで、現在このPHPスクリプトがクライアントに送信するように設定しているすべてのレスポンスヘッダーの情報を配列として取得しています。取得された配列には、設定されたヘッダー名と値が文字列形式で格納されます。

特に重要な点として、この関数が取得するのは「サーバーからクライアントへ送られるレスポンスヘッダー」であることに注意が必要です。クライアント（ブラウザなど）からサーバーへ送られてくる「リクエストヘッダー」を取得するものではありません。リクエストヘッダーを確認したい場合は、通常$_SERVERスーパーグローバル変数やgetallheaders()関数などを利用します。

最後に、取得されたレスポンスヘッダーのリストはprint_r関数によって整形され、画面に出力されます。これにより、スクリプトがどのようなHTTPレスポンスヘッダーを送信する予定であるかを確認することができます。