Cannot modify header information – headers already sent とは
PHPでWebアプリケーションを開発していると、一度は遭遇するであろう「Cannot modify header information – headers already sent」エラー。このエラーは、HTTPヘッダーが既にクライアントに送信された後に、再度ヘッダーを変更しようとした際に発生します。特にリダイレクトやセッション管理で頻繁に問題となりますが、原因が分かりづらく、デバッグに時間を要することも多いでしょう。
エラーの発生パターン
このエラーは主に以下のようなケースで発生します。
パターン1: HTMLコンテンツ出力後の `header()` 関数呼び出し
Welcome!";
// ここでヘッダーは既に送信されている
header("Location: /dashboard.php"); // Fatal error: Cannot modify header information
exit();
?>
`echo` や `print` といった関数でHTMLコンテンツが出力されると、その時点でHTTPヘッダーもクライアントに送信されてしまいます。一度ヘッダーが送信されると、その後に `header()` 関数を使ってリダイレクトなどのヘッダー操作を行おうとしても、「headers already sent」エラーが発生します。
パターン2: PHPファイルの先頭にある空白文字やBOM(Byte Order Mark)
PHPスクリプトファイルの先頭に、PHPタグ `空白文字(スペース、タブ、改行)や、UTF-8 BOM(Byte Order Mark)が含まれている場合、それらがコンテンツとして解釈され、ヘッダーが送信されてしまいます。特にBOMは目に見えないため、原因特定が困難になりがちです。
パターン3: `print_r` や `var_dump` などデバッグ出力の使用
1, 'name' => 'Test'];
var_dump($data); // デバッグ出力でヘッダーが送信される
// その後でクッキーを設定しようとするとエラー
setcookie('user_session', 'abc', time() + 3600);
?>
開発中にデバッグ目的で `print_r()`、`var_dump()`、`echo` などの関数を使用して変数の中身を出力すると、その出力がHTTPヘッダーよりも先にクライアントに送信されてしまいます。これにより、その後の`setcookie()` や `header()` などのヘッダー操作が失敗します。
1, 'name' => 'Test'];
// デバッグ出力は条件付きにするか、ヘッダー送信後に移動するか、ログファイルに出力する
// if (ENV === 'development') { var_dump($data); }
error_log(print_r($data, true)); // ログに出力
// ヘッダー操作は出力より前に行う
setcookie('user_session', 'abc', time() + 3600);
?>
根本原因の特定方法
エラーメッセージに表示される `{marker}output started at …{/marker}` の箇所を特定し、そのファイルと行番号を確認することが第一歩です。その行に直接の出力がない場合でも、その行より前に何らかの出力が発生している可能性を疑いましょう。`grep` コマンドやIDEの検索機能で、ファイル内の `echo`, `print`, `var_dump`, `print_r` などの出力関数、またはPHPタグ外の文字を検索します。
防止策とベストプラクティス
最も確実な予防策は、{marker}HTTPヘッダーを操作する処理(`header()`、`setcookie()`、`session_start()` など)を、あらゆるコンテンツ出力よりも前に行う{/marker}ことです。また、PHPファイルの保存時にBOMなしUTF-8エンコーディングを使用し、ファイルの先頭や末尾に不要な空白文字や改行を入れないように徹底しましょう。
Dashboard
よくある質問(FAQ)
-
Q本番環境でだけこのエラーが発生するのはなぜですか?
-
A
開発環境と本番環境でPHPの設定(`output_buffering` のON/OFFなど)やWebサーバーの挙動が異なる場合によく発生します。また、本番環境で予期せぬログ出力や計測スクリプトがヘッダー送信前に実行されるケースもあります。設定の違いを疑ってみましょう。
-
Q`ob_start()` を使えばこのエラーは完全に回避できますか?
-
A
`ob_start()` は出力をバッファリングするため、ヘッダーエラーの発生を一時的に防ぐことができますが、根本原因を解決するものではありません。デバッグを難しくしたり、メモリ消費が増えたりする可能性もあるため、安易な使用は避けるべきです。根本原因の特定と修正を優先しましょう。
-
QLaravelやSymfonyなどのフレームワークを使っている場合でも、このエラーは起こりますか?
-
A
はい、フレームワークはヘッダー操作を抽象化しますが、`dd()` や `var_dump()` といったデバッグ関数を不適切なタイミングで呼び出したり、ビューファイルにPHPタグ外の余計な出力があったりすると、やはりこのエラーは発生します。フレームワークが提供するデバッグツールやロギング機能を活用しましょう。
-
QこのエラーをLinterや静的解析ツールで事前に検出できますか?
-
A
PHPStanやPsalmなどの静的解析ツールは、直接的なヘッダーエラーを検出するのは難しいですが、PHPタグ外の出力や不適切な `echo` の使用パターンなど、間接的な原因となるコードスタイル違反を警告することは可能です。コード品質を向上させることで、間接的にエラーの発生を減らせます。
-
Qエラー発生時、ユーザーにはどのようなエラー画面を表示すべきですか?
-
A
ヘッダーが既に送信されているため、カスタムエラーページへのリダイレクトはできません。そのため、Webサーバー側で500エラーページを設定するか、`try-catch` で致命的なエラーを捕捉し、最後に表示可能な最低限のエラーメッセージを直接出力するなどの対策が必要です。ユーザーに不快感を与えないよう、シンプルで分かりやすいメッセージにしましょう。
-
QPHPファイルの先頭にBOMがあるかどうかの確認方法は?
-
A
多くのテキストエディタやIDE(VS Code, Sublime Text, PhpStormなど)では、ステータスバーやファイル設定でエンコーディングを確認できます。「UTF-8 BOM」と表示されている場合はBOMが含まれています。これを「UTF-8 (BOMなし)」に変更して保存し直してください。`hexdump` コマンドでファイル内容をバイナリで確認することも可能です。
-
Q複数のファイルでヘッダー操作を行う際のベストプラクティスは?
-
A
ヘッダー操作は、スクリプトの実行フローの{marker}なるべく早い段階で、一元的に行う{/marker}のがベストプラクティスです。例えば、フロントコントローラーパターンを採用し、ルーティングや認証処理の初期段階で必要なヘッダーを設定し、コンテンツ出力はその後に行うように設計します。これにより、ヘッダー操作のタイミングを管理しやすくなります。
この用語と一緒に知っておきたい用語
| 用語 | この記事との関連 |
|---|---|
| デバッガ | このエラーの発生箇所を特定するために、デバッガは非常に有効なツールです。 |
| DRY原則 | ヘッダー操作を特定の箇所に集約することで、出力前に行うことを徹底し、このエラーを予防できます。 |
| ソケット通信 | HTTPヘッダーはクライアントとのソケット通信を通じて送信されるため、その仕組みを理解することがエラー解決に役立ちます。 |
| キャッシュ | HTTPヘッダーはキャッシュ制御にも用いられるため、ヘッダー操作の失敗がキャッシュの挙動に影響を与える可能性があります。 |
| 404エラー | リダイレクトが失敗し、期待するページへ遷移できない場合、結果的にクライアント側で404エラーとして認識されることがあります。 |


コメント