getenv

(PHP 4, PHP 5, PHP 7, PHP 8)

getenvRetourne la valeur d'une seule ou toutes les variables d'environnement

Description

getenv(?string $name = null, bool $local_only = false): string|array|false

Retourne la valeur d'une seule ou toutes les variables d'environnement.

Vous pouvez voir une liste complète des variables d'environnement en utilisant la fonction phpinfo(). Vous pouvez trouver la signification de chacune d'entre elles en consultant la » RFC 3875, en particulier la section 4.1 "Request Meta-Variables".

Liste de paramètres

name

Le nom de la variable en tant que chaîne de caractères ou null.

local_only

Lorsqu'il est défini sur true, seules les variables d'environnement locales sont renvoyées, définies par le système d'exploitation ou putenv. Cela n'a d'effet que lorsque name est une chaîne de caractères.

Valeurs de retour

Retourne la valeur de la variable d'environnement name, ou false si la variable d'environnement name n'existe pas. Si name est omit, toutes les variables d'environnement sont retournée en tant qu'un tableau associatif.

Historique

Version Description
8.0.0 Le name est désormais nullable.
7.1.0 name peut désormais être omit pour récupérer un tableau associatif de toutes les variables d'environnement.
7.0.9 Le paramètre local_only a été ajouté.

Exemples

Exemple #1 Exemple avec getenv()

<?php
// Exemple d'utilisation de getenv()
$ip = getenv('REMOTE_ADDR');

// Ou utilisez simplement une Superglobale ($_SERVER ou $_ENV)
$ip = $_SERVER['REMOTE_ADDR'];

// Obtenir en toute sécurité la valeur d'une variable d'environnement,
// ignorant si elle a été définie par un SAPI ou a été modifiée avec putenv
$ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR')
?>

Notes

Avertissement

Si PHP est exécuté dans un SAPI tel que Fast CGI, cette fonction retournera toujours la valeur d'une variable d'environnement définit par le SAPI, même si putenv() a été utilisé pour définir une variable d'environnement locale avec le même nom. Le paramètre local_only doit être utilisé pour retourner les valeurs de variables d'environnements définit localement.

Voir aussi