PHP 省略閉合標籤 ?> 的最佳實踐：避免 Header Already Sent 錯誤

PHP 手冊明確建議：純 PHP 檔案應省略結束標籤 ?>。這不是風格偏好，而是為了避免「輸出緩衝區過早發送」導致的 Cannot modify header information - headers already sent 錯誤。本文深入剖析原理、實際案例與團隊規範落地。

錯誤發生機制

PHP 處理流程：

1. 解析器遇到 <?php 進入 PHP 模式
2. 遇到 ?> 退出 PHP 模式，進入 HTML 輸出模式
3. 任何位於 ?> 之後的字元（空白、換行、BOM、不可見字元）都會被直接輸出到瀏覽器
4. 一旦有輸出發送，HTTP Header 階段結束，後續 header()、setcookie()、session_start() 皆會失敗

典型失敗場景

<?php
// config.php
$config = ['db' => 'mysql'];
?> 

<?php
// index.php
require 'config.php';
session_start(); // 錯誤！Header already sent
?>

甚至使用 IDE 自動格式化、FTP 傳輸時自動轉換換行符、Git checkout 時行尾轉換，都可能在 ?> 後引入不可見字元。

官方與框架規範

推薦檔案結尾格式

<?php
// src/Service/UserService.php
namespace App\Service;

class UserService {
    public function getUser(int $id): array {
        // ...
    }
}
// 結尾註解：標示檔案結束與相對路徑
// EOF
// Path: src/Service/UserService.php

例外情況：模板檔案

若檔案包含 HTML 輸出（如 .phtml、.blade.php、.twig），必須保留 閉合標籤以正確切換輸出模式：

<?php $title = '頁面標題'; ?>
<h1><?= htmlspecialchars($title) ?></h1>
<p>內容...</p>

工具鏈自動化檢查

1. PHP_CodeSniffer 規則

<?xml version="1.0"?>

    
         
    
    
        
            
        
    
    

2. PHPStan / Psalm 靜態分析

雖無內建規則，可編寫自訂規則掃描 T_CLOSE_TAG token 後是否存在非空白內容。

3. Git Pre-commit Hook

#!/bin/bash
# .git/hooks/pre-commit
files=$(git diff --cached --name-only -- '*.php')
for f in $files; do
    if grep -q '^.*?>\s*$' "$f" && ! grep -q '<\?php' "$f" | head -1 | grep -q 'html\|echo\|print'; then
        echo "Warning: $f contains closing tag in pure PHP file"
        # exit 1 # 嚴格模式可阻止提交
    fi
done

常見誤區澄清

團隊落地清單

• ✅ 代碼規範文檔明確寫入「純 PHP 檔案禁止閉合標籤」
• ✅ IDE 設定：PhpStorm → Editor → Code Style → PHP → "Insert closing tag" = Never
• ✅ CI 管線整合 PHP_CodeSniffer 自訂規則檢查
• ✅ Code Review 清單加入「檢查純 PHP 檔案結尾」項目
• ✅ 歷史專案批次清理：find . -name '*.php' -exec sed -i '/^.*?>\s*$/d' {} \;（謹慎備份後執行）

省略 ?> 是零成本、高收益的防禦性編程習慣，建議所有 PHP 專案立即落地執行。