Php header content type values

PHP header

PHP header function is to send a raw HTTP header to the client. The raw header contains the request and other metadata. It helps to set content type, caching, location and similar data.

The HTTP header is to pass additional details with an HTTP request. It contains the details in the form of key: value pairs.

Quick Example

To redirect after X seconds:

The header() is a built-in PHP function existing even in earlier versions. But as of 5.1.2, it stops sending more than one header at a time to avoid the header injection attacks.

PHP header must be called before sending any output to the browser . Otherwise, it will cause a “Cannot modify header information . header already sent . ” error.

These are the items not allowed before calling PHP headers.

1. HTML tags.
2. Blank lines.
3. PHP print statements.
4. PHP require/include that output something to the browser.

PHP header syntax and parameters

The PHP header function has three parameters. It uses the following syntax which shows the three parameters of this function. This function returns (void) no value.

header(String $header, bool $replace=true, int $response_code=0); 

$header

It contains a string defining HTTP status code. It defines the header properties like content type, location and more.

The header location redirects users to the target URI and returns the 302 status code to the client.

$replace

It is to replace the header property already defined. This is an optional parameter having boolean true as a default value. It overrides the defined header settings by default. We can turn the default behavior off by setting false to this parameter.

$response_code

This is also an optional parameter containing the default integer value 0. This is to set the HTTP response code. It is applicable if and only if the header is not empty.

Uses of PHP header() function

The list of items shows some of the uses of the PHP header function. This article includes examples to explain the uses of the header() function.

• It changes header location and redirects the page.
• It sets content type and prompts to download content.
• It prepares the HTTP status code to respond with.
• It sets caching properties and overrides existing caching behavior.

PHP header() examples

Page redirect using header() Location

The usage of the PHP header location setting is as follows. It starts with the Location keyword followed by the target URI.
The header function executes page redirect in PHP on the server-side. The below code uses the PHP exit statement. It stops executing code follows after the redirect.

It accepts both relative and absolute URI for the redirect.

Some of the old clients accept absolute URI. The below code forms absolute URI dynamically to set the header location. It uses the $_SERVER globals $_SERVER[‘PHP_SELF’], $_SERVER[‘HTTP_HOST’] and the dirname().

The above code finds the subdirectory name of the file. Then, it trims the unnecessary slashes at the end of the string.

Output PDF file using header() content type and content-disposition

This PHP script sets content type and content-disposition to force to download. It outputs a document in the specified content type.

It set the application/pdf to output a PDF file to the browser. It sets the source and destination to read and prepare the output document.

This code will display a dialog to save the PDF document generated. We have used jsPDF save() method to show the download PDF into the browser.

If you want to send response as a JSON, in the above change “Content-type” to application/json.

Prevent page caching

Below code sets PHP header() to prevent the browser from caching the page content. By defining these header settings, it overrides the default caching mechanism.

It uses HTTP 1.1 caching options to set Cache-Control. It puts the values no-cache, must-revalidate tp this header.

It sets Expires header with a past date and lets the client know that there is no more cached content. So, it will send a HTTP request to the server to read the content.

Related PHP functions and examples

The below functions are related to the PHP header function. Let us see the purposes of these functions with a simple example.

header_sent()

This function ensures that the header is already sent to the client. It will return boolean true or false.

It accepts optional $filename and $linenumber params passed by reference. It will be used later and no need to assign them before the header_sent() invoke.

PHP sets the source filename to the $filename parameter. Also, it sets the second parameter with the line number where the output begins.

This function avoids the occurrence of header-related fatal errors. The below example prints explicit error messages by interpolating variables $filename and $linenum.

 // Set optional $filename of the source PHP and // $linenum where output starts if (!headers_sent($filename, $linenum)) < header('Location: http://yourdomain.com/'); exit; >else < // prints error message to avoid fatal errors echo "Headers already sent in $filename on line $linenum"; exit; >?> 

header_remove()

The purpose of this function is understandable by its name. It is for removing the header that is already set.

It accepts the name of the header as its parameter. Its value is case insensitive.

header_list()

This PHP function returns the list of headers sent already or the headers set to be sent. It returns output in the form of PHP array.

This code set cookies and PHP headers. It sets member random id into PHP cookie index and sets the content type as plain text.

This program prints the header list as follows.

array(4) < [0] = >string(24) "X-Powered-By: PHP/7.4.21" [1] = > string(27) "Set-Cookie: member_id=87530" [2] = > string(17) "X-Sample: Example" [3] = > string(38) "Content-type: text/plain;charset=UTF-8" > 

header_register_callback()

The header_register_callback() function is to register a no-argument callback function. PHP invokes the callback function after it is ready to send all the headers.

header_register_callback(callable $callbackFunction); 

Conclusion

Yes, we have seen an elaborate article on PHP headers. I hope that it covers all the direct and related points about this function.

It gives a variety of examples in PHP headers to set content type, caching and more. Also, it covers the related functions like header_list(), header_remove(), etc.

If you have comments or suggestions, share them in the comments section.

Comments to “PHP header”

ôh what generous women you are vincy , thank you every time every day thank you forever vincy this article come just the time i need to it , it’s very important so clear it give me help

As always, this is brilliant. Thank you so much for creating these extraordinarily useful tutorials.
Best regards
Rob

Источник

header

header() используется для отправки HTTP заголовка. В » спецификации HTTP/1.1 есть подробное описание HTTP заголовков.

Помните, что функцию header() можно вызывать только если клиенту еще не передавались данные. То есть она должна идти первой в выводе, перед ее вызовом не должно быть никаких HTML тэгов, пустых строк и т.п. Довольно часто возникает ошибка, когда при чтении кода файловыми функциями, вроде include или require , в этом коде попадаются пробелы или пустые строки, которые выводятся до вызова header() . Те же проблемы могут возникать и при использовании одиночного PHP/HTML файла.

/* Этот пример приведет к ошибке. Обратите внимание
* на тэг вверху, который будет выведен до вызова header() */
header ( ‘Location: http://www.example.com/’ );
exit;
?>

Список параметров

Существует два специальных заголовка. Один из них начинается с «HTTP/» (регистр не важен) и используется для отправки кода состояния HTTP. Например, если веб-сервер Apache сконфигурирован таким образом, чтобы запросы к несуществующим файлам обрабатывались средствами PHP скрипта (используя директиву ErrorDocument), вы наверняка захотите быть уверенными что скрипт генерирует правильный код состояния.

Другим специальным видом заголовков является «Location:». В этом случае функция не только отправляет этот заголовок броузеру, но также возвращает ему код состояния REDIRECT (302) (если ранее не был установлен код 201 или 3xx).

header ( «Location: http://www.example.com/» ); /* Перенаправление броузера */

/* Можно убедиться, что следующий за командой код не выполнится из-за
перенаправления.*/
exit;
?>

Необязательный параметр replace определяет, надо ли заменять предыдущий аналогичный заголовок или заголовок того же типа. По умолчанию заголовок будет заменен, но если передать FALSE , можно задать несколько однотипных заголовков. Например:

Принудительно задает код ответа HTTP. Следует учитывать, что это будет работать, только если строка string не является пустой.

Возвращаемые значения

Эта функция не возвращает значения после выполнения.

Список изменений

Версия	Описание
5.1.2	Стало невозможно отправлять более одного заголовка за раз. Это сделано для защиты от атак, связанных с инъекцией заголовков.

Примеры

Пример #1 Диалог загрузки

Если нужно предупредить пользователя о необходимости сохранить пересылаемые данные, такие как сгенерированный PDF файл, можно воспользоваться заголовком » Content-Disposition, который подставляет рекомендуемое имя файла и заставляет броузер показать диалог загрузки.

// Будем передавать PDF
header ( ‘Content-Type: application/pdf’ );

// Который будет называться downloaded.pdf
header ( ‘Content-Disposition: attachment; filename=»downloaded.pdf»‘ );

// Исходный PDF файл original.pdf
readfile ( ‘original.pdf’ );
?>

Пример #2 Директивы для работы с кэшем

PHP скрипты часто генерируют динамический контент, который не должен кэшироваться клиентским броузером или какими-либо промежуточными обработчиками, вроде прокси серверов. Можно принудительно отключить кэширование на многих прокси серверах и броузерах, передав заголовки:

header ( «Cache-Control: no-cache, must-revalidate» ); // HTTP/1.1
header ( «Expires: Sat, 26 Jul 1997 05:00:00 GMT» ); // Дата в прошлом
?>

Замечание:

В некоторых случаях ваши страницы не будут кэшироваться броузером, даже если вы не передавали этих заголовков. В броузерах есть определенные настройки, с помощью которых пользователь может изменять обычный ход кэширования, отключать его. Вы должны перекрывать любые настройки, которые могут повлиять на кэширование скрипта, отправляя приведенные выше заголовки.

Дополнительно, для случаев когда используются сессии, можно задать настройки конфигурации session_cache_limiter() и session.cache_limiter. Эти настройки можно использовать для автоматической генерации заголовков управляющих кешированием.

Примечания

Замечание:

Доступ к заголовкам и их вывод будет осуществляться только в случае, если в используемом вами SAPI есть их поддержка.

Замечание:

Чтобы обойти эту проблему, можно буферизовать вывод скрипта. В этом случае все выводимые данные будут буферизоваться на сервере, пока не будет дана явная команда на пересылку данных. Управлять буферизацией можно вручную функциями ob_start() и ob_end_flush() , либо задав директиву output_buffering в конфигурационном файле php.ini , или же настроив соответствующим образом конфигурацию сервера.

Замечание:

Строка заголовка задающая состояние HTTP всегда будет отсылаться клиенту первой, вне зависимости от того был соответствующий вызов функции header() первым или нет. Это состояние можно перезаписать, вызывая header() с новой строкой состояния в любое время, когда можно отправлять HTTP заголовки.

Замечание:

В Microsoft Internet Explorer 4.01 есть баг, из-за которого это не работает. Обойти его никак нельзя. В Microsoft Internet Explorer 5.5 также есть этот баг, но его уже можно устранить установкой Service Pack 2 или выше.

Замечание: Если включен безопасный режим, то uid скрипта будет добавляться к realm части WWW-Authenticate заголовка (используется для HTTP аутентификации).

Замечание:

Спецификация HTTP/1.1 требует указывать абсолютный URI в качестве аргумента » Location:, включающий схему, имя хоста и абсолютный путь, хотя некоторые клиенты способны принимать и относительные URI. Абсолютный URI можно построить самостоятельно с помощью $_SERVER[‘HTTP_HOST’] , $_SERVER[‘PHP_SELF’] и dirname() :

/* Перенаправление броузера на другую страницу в той же директории, что и
изначально запрошенная */
$host = $_SERVER [ ‘HTTP_HOST’ ];
$uri = rtrim ( dirname ( $_SERVER [ ‘PHP_SELF’ ]), ‘/\\’ );
$extra = ‘mypage.php’ ;
header ( «Location: http:// $host$uri / $extra » );
exit;
?>

Замечание:

ID сессии не будет передаваться вместе с заголовком Location, даже если включена настройка session.use_trans_sid. Его нужно передавать вручную, используя константу SID .

Смотрите также

• headers_sent() — Проверяет были ли и куда отправлены заголовки
• setcookie() — Посылает cookie
• http_response_code() — Получает или устанавливает код ответа HTTP
• Раздел документации HTTP аутентификация

Источник