headers_list

(PHP 5, PHP 7, PHP 8)

headers_list — 返回已发送的 HTTP 响应头（或准备发送的）

说明

headers_list(): array

headers_list() 会返回准备发送给浏览器/客户端的 HTTP 头列表。检测这些头是否已经发送，使用 headers_sent()。

参数

此函数没有参数。

返回值

返回数字索引的头数组。

范例

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


<?php

/* setcookie() 会自己添加一个响应头 */
setcookie('foo', 'bar');

/* 添加自定义的响应头
 大多数客户端会主动忽略 */
header("Example-Test: foo");

/* 响应中指定内容为明文 text */
header('Content-Type: text/plain; charset=UTF-8');

/* 所以会发送什么头呢？ */
var_dump(headers_list());

?>

以上例程的输出类似于：

array(3) {
  [0]=>
  string(19) "Set-Cookie: foo=bar"
  [1]=>
  string(17) "Example-Test: foo"
  [2]=>
  string(39) "Content-Type: text/plain; charset=UTF-8"
}

注释

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

参见

headers_sent() - 检测 HTTP 头是否已经发送
header() - 发送原生 HTTP 头
setcookie() - 发送 Cookie
apache_response_headers() - 获得全部 HTTP 响应头信息
http_response_code() - 获取/设置响应的 HTTP 状态码

add a note

User Contributed Notes 3 notes

down

Anonymous ¶

9 years ago


note that it does not return the status header

<?php

header('HTTP/1.1 301 Moved Permanently', true, 301);

header('foo: bar');
header('a: b');
header('colon less example');

print_r(headers_list());
?>

Array
(
    [0] => X-Powered-By: PHP/5.4.7
    [1] => foo: bar
    [2] => a: b
)

down

arnold at jasny dot net ¶

5 years ago


This function won't work for when you're running PHP from the command line. If will always return an empty array. This can be an issue when testing your project using PHPUnit or Codeception.

To solve this, install the xdebug extension and use `xdebug_get_headers` when on the cli.

<?php
$headers = php_sapi_name() === 'cli' ? xdebug_get_headers() : headers_list();
?>

down

-2

SOLO2 ¶

9 years ago


Function to check if a particular header has been added to the list:

<?php

function header_sent($header) {
    $headers = headers_list();
    $header = trim($header,': ');
    $result = false;

    foreach ($headers as $hdr) {
        if (stripos($hdr, $header) !== false) {
            $result = true;
        }
    }

    return $result;
}

?>

add a note