CakeFest 2024: The Official CakePHP Conference

header_remove

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

header_remove删除之前设置的 HTTP 头

说明

header_remove(?string $name = null): void

删除之前用 header() 设置的 HTTP 头。

参数

name

要移除的头名称。当为 null,移除之前设置的所有 header。

注意: 参数不分大小写。

返回值

没有返回值。

更新日志

版本 说明
8.0.0 name 现在允许为 null。

示例

示例 #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、Session 和 X-Powered-By

注意:

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

参见

add a note

User Contributed Notes 4 notes

up
13
Saeed Khamseh
13 years ago
if you want to remove header information about php version (x-powered-by), you can use:

header_remove('x-powered-by');

alternatively, if you don't have php 5.3 installed, you can do the same thing using "header" command:

header('x-powered-by:');

don't forget the ':' character at the end of the string!
up
1
jake at qzdesign dot co dot uk
5 years ago
When called from a command-line process, this function does nothing when passed a specific header to remove, but it does nonetheless work properly when called with no arguments to remove all headers.

Thus, when unit-testing or executing in some other test harness, if the code you are testing may call `header_remove()`, with the UOPZ and XDebug extensions loaded, you could use the following in order to more effectively test that the expected headers are set [which you would do by inspecting the array returned by `xdebug_get_headers()` after running the code under test, as `headers_list()` does not work despite the headers actually being stored internally as normal]:

<?php
uopz_set_return
(
 
'header_remove',
  function(
$name = null) {
    if (
$name !== null) {
     
$pattern = '/^' . preg_quote($name, '/') . ':/i';
     
$headers = array_filter(
       
xdebug_get_headers(),
        function(
$header) use($pattern) {
          return !
preg_match($pattern, $header);
        }
      );
    }
   
// This works to remove all headers, just not individual headers.
   
header_remove();
    if (
$name !== null) {
      foreach (
$headers as $header) {
       
header($header);
      }
    }
  },
 
true
);
?>
up
3
Anonymous
8 years ago
expose_php is php.ini only!

this won't work:
ini_set('expose_php',0);

works:
header_remove('x-powered-by');
up
-16
J W
9 years ago
You should ini_set("expose_php", 0); or set it in your php.ini to Off, instead of using this to remove X-Powered-By header.
To Top