getenv

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

getenvRetorna el valor de una o todas las variables de entorno

Descripción

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

Retorna el valor de una o todas las variables de entorno.

Puede verse una lista completa de las variables de entorno utilizando la función phpinfo(). Puede encontrarse el significado de cada una de ellas consultando la » RFC 3875, en particular la sección 4.1 "Request Meta-Variables".

Parámetros

name

El nombre de la variable como chaîne de caractères o null.

local_only

Cuando se establece en true, solo se retornan las variables de entorno locales, definidas por el sistema operativo o putenv. Esto solo tiene efecto cuando name es un chaîne de caractères.

Valores devueltos

Retorna el valor de la variable de entorno name, o false si la variable de entorno name no existe. Si name es omitido, todas las variables de entorno son retornadas como un tableau asociativo.

Historial de cambios

Versión Descripción
8.0.0 El name ahora es nullable.
7.1.0 name ahora puede ser omitido para recuperar un tableau asociativo de todas las variables de entorno.
7.0.9 Se ha añadido el parámetro local_only.

Ejemplos

Ejemplo #1 Ejemplo con getenv()

<?php
// Ejemplo de uso de getenv()
$ip = getenv('REMOTE_ADDR');

// O simplemente usar una Superglobal ($_SERVER o $_ENV)
$ip = $_SERVER['REMOTE_ADDR'];

// Obtener de forma segura el valor de una variable de entorno,
// ignorando si ha sido definida por un SAPI o modificada con putenv
$ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR')
?>

Notas

Advertencia

Si PHP se ejecuta en un SAPI como Fast CGI, esta función retornará siempre el valor de una variable de entorno definida por el SAPI, incluso si putenv() ha sido utilizado para definir una variable de entorno local con el mismo nombre. El parámetro local_only debe ser utilizado para retornar los valores de variables de entorno definidas localmente.

Ver también