PHP header() Function
Note: There are options that users may set to change the browser’s default caching settings. By sending the headers above, you will override any of those settings and force the browser to not cache!
Definition and Usage
The header() function sends a raw HTTP header to a client.
It is important to notice that the header() function must be called before any actual output is sent!
Syntax
Parameter Values
| Parameter | Description |
|---|---|
| header | Required. Specifies the header string to send |
| replace | Optional. Indicates whether the header should replace a previous similar header or add a new header of the same type. Default is TRUE (will replace). FALSE allows multiple headers of the same type |
| http_response_code | Optional. Forces the HTTP response code to the specified value |
Technical Details
| Return Value: | Nothing |
|---|---|
| PHP Version: | 4.0+ |
| PHP Changelog: | PHP 5.1.2: Now prevents that more than one header to be sent at once. This is a protection against header injection attacks |
More Examples
Example
Let the user be prompted to save a generated PDF file (Content-Disposition header is used to supply a recommended filename and force the browser to display the save dialog box):
// It will be called downloaded.pdf
header(«Content-Disposition:attachment;filename=’downloaded.pdf'»);
// The PDF source is in original.pdf
readfile(«original.pdf»);
?>
Функция header
HTTP заголовки это специальная информация, которая присоединяется к документу, то есть, к тому файлу, который запрашивается браузером с сервера. Когда мы вбиваем в адресную строку какой-нибудь адрес то, соответственно, запрашиваем на сервере по этому адресу какой-нибудь документ. Эта информация(документ) видна у нас на экране. Но кроме видимой части есть еще и невидимая — те самые HTTP заголовки, которые отправляются сервером браузеру и они нужны для того, чтобы браузер корректно отобразил страницу. То есть, заголовки подсказывают браузеру как показать страницу или как отдать страницу.
Для браузера firefox: кнопка F12 -> сеть -> кликнуть «статус» и обновить страницу :
Среди прочего в заголовках отправляется информация о кодировке страницы, как давно модифицировалась страница, информация о том, что это за страница (html-страница, обычный текстовый документ; или, вместо того чтобы показать страницу, отдать ее на скачивание)
Установление кодировки
Один, из наиболее часто используемых вариантов функции header , это использование функции для установления кодировки.
В файле index.php в папке с нашим уроком запишем: привет, мир! и посмотрим в браузере, что получили. Мы можем получить крабозябры . Это происходит по тому, что браузер будет открывать документ в той кодировке, которую сервер отправил в заголовках по умолчанию. Если кодировка нашего документа не совпадает с кодировкой сервера — получим крабозябры.
Кодировка для всех частей нашего приложения должна быть единой .
Рекомендуется всегда использовать кодировку utf-8 — как универсальную кодировку.
Использование метатэга — не всегда помогает, потому что сервер может отправлять по умолчанию свою кодировку в заголовках и в этом случае она будет иметь больший приоритет, чем метатэг charset .
В этом случае мы должны переопределить кодировку сервера с помощью функции header . (php.net)
Функция header позволяет указать нужную нам кодировку.
header ( ‘Content-Type: text/html; charset=utf-8’ );
?>
где:
text/html — тип документа;
charset=utf-8 — нужная нам кодировка.
Если посмотрим заголовки в «разработка/инструменты разработчика/сеть» (в firefox ), то увидим, что они дополнились кодировкой charset=»UTF-8″ , то есть, мы указали браузеру (отправили заголовки), что нужно использовать именно данную кодировку. При этом она имеет приоритет над метатэгом charset .
Еще один способ установления кодировки по умолчанию — это использовать специальный файл .htaccess . Данный файл является файлом настройки сервера Apache .
Создадим даннный файл в нашей папке.
Установим кодировку для сервера по умолчанию с помощью специальной директивы AddDefaultCharset .
Данная директива заставляет сервер отправлять в заголовках кодировку, указанную в качестве значения данной дериктивы.
Организация редиректа
Функцию header часто используют для редиректа .
Создадим новый файл — inc.php и выведем в нем строку: «привет из подключаемого файла» .
echo ‘Привет из подключаемого файла’ ;
?>
В индексном файле используем функцию header для редиректа. Его можно сделать двумя командами:
— командой ‘ Location ‘
— командой ‘ refresh ‘
header ( ‘Content-Type: text/html; charset=utf-8’ );
header ( ‘Location: inc.php’ ); // где inc.php — относительный путь к файлу
?>
При работе с редиректом нужно помнить что редирект происходит не сразу. Когда отрабатывает
данная команда ( header(‘Location: inc.php’); ), выполнение файла продолжается дальше.
Чтобы сделать безусловный редирект и не выполнять дальнейший код нужно воспользоватся
одной из двух команд — функция die (пер.- умри) и функция exit (пер.- выйти).
Эти команды почти всегда рекомендуется использовать после редиректа.
Чтобы убедиться, что у нас код после команды редиректа выполняется, используем редирект
с задержкой: header(‘refresh: 5, url’) , где
5 — время задержки в секундах,
url=inc.php — адрес, на который должен быть перенаправлен пользователь (если внешний адрес,
то используем — http, если внутренний, то используем — относительный путь к файлу ).
Запускаем файл index.php:
header ( ‘Content-Type: text/html; charset=utf-8’ );
header( ‘Location: inc.php’ );
// — где inc.php — относительный путь к файлу
header ( ‘refresh: 5, url=inc.php’ );
// — адрес, на который должен быть перенаправлен пользователь
— после загрузки документа весь код у нас выполнился — выводится: привет мир!
После пятисекундной задержки нас перенаправляет на другой файл ( inc.php ) — выводится: привет из подключаемого файла .
Чтобы код не выполнялся используем любую из функций: либо exit , либо die .
header ( ‘Content-Type: text/html; charset=utf-8’ );
header( ‘Location: inc.php’ );
// — где inc.php — относительный путь к файлу
header ( ‘refresh: 5, url=inc.php’ );
exit ;
// die;
?>
— после загрузки документа код у нас не выполняется — видим пустую страницу.
После пятисекундной задержки перенаправляемся на другой файл — выводится: привет из подключаемого файла .
Проблемы вывода
Функция header отправляет заголовки в браузер. Они помогают коректно отобразить страницу. Эти заголовки должны бать отправленны раньше перед самим контентом страницы, поскольку браузер должен проанализировать заголовки и, в соответствии с ними, показать нашу страницу. Поэтому заголовки должны быть всегда отправленны до вывода , при этом заголовки могут отправлятся только один раз .
Если мы инициализируем вывод в браузер, то заголовки автоматически будут отправленны. Это значит, что если перед функцией header есть какой-то вывод в браузер, то она просто не отработает.
1. В этом легко убедиться, если в индексном файле поставим какой нибудь вывод, например, перенос строки перед функцией header :
— не удается изменить информацию заголовка — заголовки уже отправленны .
Выводом считается любой символ , который показывается в браузере, например, даже пробел.
2. С проблемой вывода можно столкнуться при подключении какого нибудь файла.
Например, мы подключаем файл inc.php, и в нем есть какая-то переменная — $test = ‘TEST’ .
В индексном файле мы хотим использовать данную переменную: $test ?> .