headers_sent

(PHP 4, PHP 5, PHP 7, PHP 8)

headers_sent — 检测消息头是否已经发送

说明

headers_sent(string &$filename = null, int &$line = null): bool

检测消息头是否已经发送。

消息头已经发送时，就无法通过 header() 添加更多头字段。使用此函数起码可以防止收到跟消息头相关的错误。另一个解决方案是用输出缓冲。

参数

filename: 若设置了可选参数 filename 和 line，headers_sent() 会把 PHP 文件名放在 filename 变量里，输出开始的行号放在 line 变量里。

注意:
如果在执行 PHP 源文件之前已经开始输出（例如由于启动错误），则 filename 参数将被设置为空字符串。
line: 输出开始的行号。

返回值

消息头未发送时，headers_sent() 返回 false，否则返回 true。

示例

示例 #1 使用 headers_sent() 的例子

<?php

// 没有消息头就发送一个
if (!headers_sent()) {
    header('Location: http://www.example.com/');
    exit;
}

// 使用 file 和 line 参数选项的例子
// 注意 $filename 和 $linenum 用于下文中使用
// 所以不要提前为它们赋值
if (!headers_sent($filename, $linenum)) {
    header('Location: http://www.example.com/');
    exit;

// 很有可能在这里触发错误
} else {

    echo "Headers already sent in $filename on line $linenum\n" .
          "Cannot redirect, for now please click this <a " .
          "href=\"http://www.example.com\">link</a> instead\n";
    exit;
}

?>

注释

注意:
数据头只会在SAPI支持时得到处理和输出。

参见

ob_start() - 打开输出控制缓冲
trigger_error() - 产生一个用户级别的 error/warning/notice 信息
headers_list() - 返回已发送的 HTTP 响应头（或准备发送的）
header() - 发送原生 HTTP 头中有更多相关细节的讨论。