(PHP 4, PHP 5, PHP 7, PHP 8)
header — Envoie un en-tête HTTP brut
Description
header(string
$header, bool
$replace =
true, int
$response_code = 0): void
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 affichages
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 produiront
un affichage avant que la fonction header()
ne soit appelée. Le même problème existe avec les fichiers
PHP/HTML standards.
<html>
<?php
/* Ceci produira une erreur. Notez la sortie ci-dessus,
* qui se trouve avant l'appel à la fonction header() */
header('Location: http://www.example.com/');
exit;
?>
Liste de paramètres
-
header
-
L'en-tête.
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),
assurez-vous que le script génère un code statut correct.
<?php
// This example illustrates the "HTTP/" special case
// Better alternatives in typical use cases include:
// 1. header($_SERVER["SERVER_PROTOCOL"] . " 404 Not Found");
// (to override http status messages for clients that are still using HTTP/1.0)
// 2. http_response_code(404); (to use the default message)
header("HTTP/1.1 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) au navigateur
tant qu'un code statut 201 ou 3xx
n'a pas été envoyé.
<?php
header("Location: http://www.example.com/"); /* Redirection du navigateur */
/* Assurez-vous que la suite du code ne soit pas exécutée une fois la redirection effectuée. */
exit;
?>
-
replace
-
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 :
<?php
header('WWW-Authenticate: Negotiate');
header('WWW-Authenticate: NTLM', false);
?>
-
response_code
-
Force le code réponse HTTP à la valeur spécifiée. À noter que ce
paramètre a un effet uniquement si header
n'est pas vide.
Valeurs de retour
Aucune valeur n'est retournée.
Erreurs / Exceptions
Lors de l'échec de la planification de l'envoi d'un en-tête,
header() lève une erreur de niveau
E_WARNING.
Exemples
Exemple #1 Boîte de téléchargement
Si vous voulez que vos utilisateurs 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.
<?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');
?>
Exemple #2 Directives concernant la mise en cache
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 :
<?php
header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1
header("Expires: Sat, 26 Jul 1997 05:00:00 GMT"); // Date dans le passé
?>
Note:
Vous pouvez vous rendre compte que vos pages ne sont jamais mises
en cache même si vous utilisez tous les en-têtes ci-dessus.
Il existe toute une collection de paramètres que les utilisateurs
peuvent modifier sur leur navigateur pour modifier le
comportement par défaut du cache. En envoyant les en-têtes
ci-dessus, vous pouvez imposer vos propres valeurs.
De plus, les paramètres session_cache_limiter() et
session.cache_limiter peuvent être utilisés pour
générer les en-têtes de caches corrects, lorsque les sessions sont
utilisées.
Notes
Note:
Les en-têtes ne seront accessibles et s'afficheront que lorsqu'un SAPI qui les supporte sera utilisé.
Note:
Vous pouvez utiliser le système de cache (output buffering)
pour contourner ce problème. Tous vos textes générés seront
mis en buffer sur le serveur jusqu'à ce que vous les envoyiez. Vous pouvez
utiliser les fonctions ob_start() et
ob_end_flush() dans vos scripts, ou en
modifiant la directive de configuration output_buffering
dans votre fichier php.ini ou vos fichiers
de configuration du serveur.
Note:
Le code statut HTTP doit toujours être le premier à être envoyé au client,
au regard de l'actuel header() qui peut être le premier
ou non. Le statut peut être écrasé en appelant header()
avec un nouveau statut à n'importe quel moment même si l'en-tête HTTP a
déjà été envoyé.
Note:
La plupart des clients moderne accepte des URIs relative comme argument de
» Location:,
mais certains client plus ancien exigent une URI absolue
y compris le protocole, l'hôte et le chemin absolu. Vous pouvez généralement
utiliser les variables globales $_SERVER['HTTP_HOST'],
$_SERVER['PHP_SELF'] et dirname() pour
construire vous-même une URI absolue :
<?php
/* Redirection vers une page différente du même dossier */
$host = $_SERVER['HTTP_HOST'];
$uri = rtrim(dirname($_SERVER['PHP_SELF']), '/\\');
$extra = 'mypage.php';
header("Location: http://$host$uri/$extra");
exit;
?>
Note:
L'ID de session n'est pas passé avec l'en-tête Location même si
session.use_trans_sid
est activé. Il doit être passé manuellement en utilisant la constante
SID.
Voir aussi
- headers_sent() - Indique si les en-têtes HTTP ont déjà été envoyés
- setcookie() - Envoie un cookie
- http_response_code() - Récupère ou définit le code de réponse HTTP
- header_remove() - Supprime un en-tête HTTP
- headers_list() - Retourne la liste des en-têtes de réponse du script courant
-
La section sur l'identification
HTTP
![[Méthode] SoapClient::__getLastRequestHeaders](http://www.creationdev.net/secure/images/icon-methode-25x25.png "[Méthode] SoapClient::__getLastRequestHeaders"){kind=icon}
![[Classe] SoapHeader](http://www.creationdev.net/secure/images/icon-classe-25x25.png "[Classe] SoapHeader"){kind=icon}
Choississez l'un de nos types de sites internet multi-plateformes afin de pouvoir l'adapter sur les différents appareils technologiques.
