array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.getenv.php', 1 => 'getenv', 2 => 'Obtém o valor de uma única ou de todas as variáveis ​​de ambiente', ), 'up' => array ( 0 => 'ref.info.php', 1 => 'Funções para Opções/Info do PHP', ), 'prev' => array ( 0 => 'function.get-resources.php', 1 => 'get_resources', ), 'next' => array ( 0 => 'function.getlastmod.php', 1 => 'getlastmod', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'pt_BR', 'path' => 'reference/info/functions/getenv.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

getenv

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

getenv — Obtém o valor de uma única ou de todas as variáveis ​​de ambiente

Descrição

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

Obtém o valor de uma única ou de todas as variáveis ​​de ambiente.

Uma lista de todas as variáveis dem ambiente pode ser vista usando phpinfo(). Muitas dessas variáveis ​​estão listadas na » RFC 3875, especificamente na seção 4.1, "Request Meta-Variables".

Parâmetros

name

O nome da variável como uma string ou null.

local_only

Quando definido como true, apenas variáveis ​​de ambiente locais são retornadas, definidas pelo sistema operacional ou por putenv. Só tem efeito quando name é uma string.

Valor Retornado

Retorna o valor da variável de ambiente name ou false se a variável de ambiente name não existir. Se name for null, todas as variáveis ​​de ambiente serão retornadas como um array associativo.

Registro de Alterações

Versão Descrição
8.0.0 O parâmetro name agora pode ser nulo.
7.1.0 O name agora pode ser omitido para recuperar um array associativo de todas as variáveis ​​de ambiente.
7.0.9 O parâmetro local_only foi adicionado.

Exemplos

Exemplo #1 Exemplo de getenv()

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

// Ou simplesmente usa uma variável super global ($_SERVER ou $_ENV)
$ip = $_SERVER['REMOTE_ADDR'];

// Obtenha com segurança o valor de uma variável de ambiente, ignorando se
// ela foi definida ou não por uma SAPI ou se foi alterada com putenv
$ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR')
?>

Notas

Aviso

Se o PHP estiver sendo executado em uma SAPI como o Fast CGI, esta função sempre retornará o valor de uma variável de ambiente definida pela SAPI, mesmo que putenv() tenha sido usada para definir uma variável de ambiente local de mesmo nome. Use o parâmetro local_only para retornar o valor das variáveis ​​de ambiente definidas localmente.

Veja Também