header_remove

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

header_remove以前に設定したHTTPヘッダを削除する

説明

header_remove(?string $name = null): void

header()関数を使って以前に設定したHTTPヘッダを削除します。

パラメータ

name

削除するヘッダの名前。 null の場合は、以前に設定されたヘッダ全てが削除されます。

注意: このパラメータは大文字小文字を区別しません

戻り値

値を返しません。

変更履歴

バージョン 説明
8.0.0 name は、nullable になりました。

例1 特定のヘッダを削除する

<?php
header
("X-Foo: Bar");
header("X-Bar: Baz");
header_remove("X-Foo"); 
?>

上の例の出力は、 たとえば以下のようになります。

X-Bar: Baz

例2 以前設定したすべてヘッダを削除する

<?php
header
("X-Foo: Bar");
header("X-Bar: Baz");
header_remove(); 
?>

上の例の出力は、 たとえば以下のようになります。

注意

警告

この関数はPHPが設定した すべての ヘッダを削除します。 削除されるヘッダには、cookie や セッション、X-Powered-By があります。

注意:

ヘッダにアクセスできたりヘッダを出力したりするのは、 それに対応した SAPI を使っている場合のみです。

参考

  • header() - 生の HTTP ヘッダを送信する
  • headers_sent() - ヘッダが既に送信されているかどうかを調べる

関連キーワード:  ヘッダ, 削除, 設定, header, remove, 注意, 出力, 関数, パラメータ, 送信