6.13.7 header()Envoie un en-tête HTTP

header permet de spécifier l'en-tête HTTP string lors de l'envoi des fichiers HTML. Reportez-vous à HTTP/1.1 Specification pour plus d'informations sur les en-têtes HTTP .

Le paramètre optionnel replace indique si la fonction header doit remplacer un en-tête précédemment émis, ou bien ajouter un autre en-tête du même type. Par défaut, un nouvel en-tête va écraser le précédent, mais si vous passez FALSE dans cet argument, vous pouvez forcer les en-têtes multiples pour un même type d'en-tête. Par exemple :

Identification HTTP avec header

<?php header('WWW-Authenticate: Negotiate'); header('WWW-Authenticate: NTLM', false); ?>

Le second paramètre optionnel force le code de réponse HTTP à la valeur de http_response_code . Ce paramètre est disponible en PHP 4.3.0 et plus récent.

Il y a deux en-têtes spéciaux. Le premier commence par la chaîne " HTTP/ " (insensible à la casse), qui est utilisée pour signifier le statut HTTP à envoyer. Par exemple, si vous avez configuré Apache pour utiliser les scripts PHP pour gérer les requêtes vers des fichiers inexistants (en utilisant la directive ErrorDocument ), vous voulez-vous assurer que le script génère un code statut correct.

Générer une erreur 404 avec header

<?php header("HTTP/1.0 404 Not Found"); ?>

Le deuxième type d'appel spécial est "Location:" . Non seulement il renvoie un en-tête au client, mais, en plus, il envoie un statut REDIRECT (302) à Apache. Du point de vue de l'auteur de script, cela importe peu, mais pour ceux qui connaissent les rouages internes d'Apache, c'est primordial.

Redirection HTTP avec header

<?php /* Redirige le client vers le site PHP */ header("Location: http://www.php.net/"); /* Garantie que le code ci-dessous n'est jamais exécuté. */ exit(); ?>

Les scripts PHP génèrent souvent du HTML dynamiquement, qui ne doit pas être mis en cache, ni par le client, ni par les proxy intermédiaires. On peut forcer la désactivation du cache de nombreux clients et proxy avec :

Interdire la mise en cache avec header

<?php header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1 header("Expires: Mon, 26 Jul 1997 05:00:00 GMT"); // Date du passé ?>

N'oubliez jamais que header doit être appelée avant que le moindre contenu ne soit envoyé, soit par des lignes HTML habituelles dans le fichier, soit par des affichges PHP. Une erreur très classique est de lire un fichier avec include ou require , et de laisser des espaces ou des lignes vides, qui génèreront un affichage avant que la fonction header ne soit appelée. Le même problème existe avec les fichiers PHP/HTML standards.

header doit toujours être appelé en premier

<?php   require("user_logging.inc") ?> <?php   header("Content-Type: audio/x-pn-realaudio"); ?> &nbsp; // Erreur :  Notez la ligne blanche ci-dessus ?>

Si vous voulez que vos utilisateur recoivent une alerte pour sauver les fichiers générés, comme si vous génériez un fichier PDF, vous pouvez utiliser l'en-tête Content-Disposition pour fournir un nom de fichier par défaut, à afficher dans le dialogue de sauvegarde.

Utilisation de header pour générer un fichier de type PDF ou d'un autre type

<?php // Vous voulez afficher un pdf header('Content-type: application/pdf'); // Il sera nommé downloaded.pdf header('Content-Disposition: attachment; filename="downloaded.pdf"'); // Le source du PDF original.pdf readfile('original.pdf'); ?>

Note

Il y a un bogue sous Microsoft Internet Explorer 4.01 qui empêche cet en-tête de fonctionner. Il n'y a pas d'autre solution. Il y a aussi un bogue dans Microsoft Internet Explorer 5.5 qui interfère avec ceci, mais qui peut être résolu en utilisant le Service Pack 2 ou plus récent.

Voir aussi headers_sent , setcookie et la section sur l'identification HTTP .