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

<?php

// header_remove() 関数は、HTTPヘッダーがブラウザに送信される前に呼び出す必要があります。
// echoなどで出力が行われた後でもヘッダーを操作できるよう、出力バッファリングを開始します。
ob_start();

echo "<h1>PHP header_remove() 関数の使用例</h1>";
echo "<p>この例では、HTTPレスポンスヘッダーの設定と削除の方法を示します。</p>";

// --- 1. いくつかのHTTPヘッダーを設定する ---
// header() 関数を使用して、ブラウザに送信されるカスタムHTTPヘッダーを追加します。
header("X-Custom-Status: Active");
header("X-Request-ID: abc-123-def-456");
header("Cache-Control: no-cache, no-store, must-revalidate");
header("Content-Type: text/html; charset=utf-8");

echo "<h2>1. 初期設定後のHTTPヘッダー:</h2>";
echo "<pre>";
// headers_list() 関数は、現在設定されているすべてのHTTPヘッダーのリストを返します。
print_r(headers_list());
echo "</pre>";

// --- 2. 特定のHTTPヘッダーを削除する ---
// header_remove() にヘッダー名を指定して呼び出すと、そのヘッダーのみが削除されます。
// ここでは 'X-Request-ID' ヘッダーを削除します。
header_remove('X-Request-ID');

echo "<h2>2. 'X-Request-ID' 削除後のHTTPヘッダー:</h2>";
echo "<pre>";
print_r(headers_list());
echo "</pre>";

// --- 3. すべてのHTTPヘッダーを削除する ---
// header_remove() を引数なしで呼び出すと、header() 関数で設定されたすべてのヘッダーが削除されます。
// ただし、ウェブサーバーやPHP自身が自動的に追加するヘッダー（例: Date, Server）は
// 削除されない場合があります。
header_remove();

echo "<h2>3. すべてのカスタムヘッダー削除後のHTTPヘッダー:</h2>";
echo "<pre>";
print_r(headers_list());
echo "</pre>";

// 出力バッファリングを終了し、バッファに溜められた内容（HTMLとHTTPヘッダー）をブラウザに送信します。
ob_end_flush();

?>

PHPのheader_remove()関数は、ウェブブラウザに送信されるHTTPレスポンスヘッダーを削除するために使用されます。この関数は、引数$nameに削除したいヘッダー名を文字列で指定すると、その名前のヘッダーのみを削除します。例えば、header_remove('X-Request-ID')と記述すると、X-Request-IDヘッダーが削除されます。引数を省略してheader_remove()と呼び出した場合は、PHPのheader()関数で設定されたカスタムヘッダーがすべて削除されます。ただし、ウェブサーバーやPHP自身が自動的に追加する一部のヘッダー（例: Date, Serverなど）は削除されない場合がありますのでご注意ください。この関数はvoidを返すため、処理の成功や結果を直接取得することはできません。

header_remove()は、HTTPヘッダーがブラウザに送信される前、つまりプログラムから何らかの出力が行われる前に呼び出す必要があります。サンプルコードでは、ob_start()による出力バッファリングを利用し、header()でヘッダーを設定した後、headers_list()で現在の設定を確認しながら、特定のヘッダーや全てのカスタムヘッダーを削除する動作を示しています。これにより、動的にHTTPヘッダーを管理し、柔軟なレスポンスを生成することが可能です。