header_remove

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

header_removeRemove previously set headers

Description

header_remove(?string $name = null): void

Removes an HTTP header previously set using header().

Parameters

name

The header name to be removed. When null, all previously set headers are removed.

Note: This parameter is case-insensitive.

Return Values

No value is returned.

Changelog

Version Description
8.0.0 name is nullable now.

Examples

Example #1 Unsetting specific header.

<?php
header
("X-Foo: Bar");
header("X-Bar: Baz");
header_remove("X-Foo");
?>

The above example will output something similar to:

X-Bar: Baz

Example #2 Unsetting all previously set headers.

<?php
header
("X-Foo: Bar");
header("X-Bar: Baz");
header_remove();
?>

The above example will output something similar to:

Notes

Caution

This function will remove all headers set by PHP, including cookies, session and the X-Powered-By headers.

Note:

Headers will only be accessible and output when a SAPI that supports them is in use.

See Also

add a note 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
2
jake at qzdesign dot co dot uk
6 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
4
Anonymous
9 years ago
expose_php is php.ini only!

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

works:
header_remove('x-powered-by');
up
-10
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