PHP 8.4.0 RC2 available for testing

getenv

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

getenvObté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 embiente 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
// Examplo 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

add a note

User Contributed Notes 12 notes

up
49
Anonymous
6 years ago
Contrary to what eng.mrkto.com said, getenv() isn't always case-insensitive. On Linux it is not:

<?php
var_dump
(getenv('path')); // bool(false)
var_dump(getenv('Path')); // bool(false)
var_dump(getenv('PATH')); // string(13) "/usr/bin:/bin"
up
13
yw()beeznest!com
8 years ago
As noted on httpoxy.org, getenv() can confuse you in having you believe that all variables come from a "safe" environment (not all of them do).

In particular, $_SERVER['HTTP_PROXY'] (or its equivalent getenv('HTTP_PROXY')) can be manually set in the HTTP request header, so it should not be considered safe in a CGI environment.

In short, try to avoid using getenv('HTTP_PROXY') without properly filtering it.
up
26
eng.mrkto.com
14 years ago
This function is useful (compared to $_SERVER, $_ENV) because it searches $varname key in those array case-insensitive manner.
For example on Windows $_SERVER['Path'] is like you see Capitalized, not 'PATH' as you expected.
So just: <?php getenv('path') ?>
up
9
jcastromail at yahoo dot es
4 years ago
I did a benchmark about env.

constants :
0.00067687034606934 ms
getenv :
0.056761026382446 ms

(less is better)

https://github.com/eftec/php-benchmarks#define--const--env

And, in Windows at leat, reading the env value is considerably slow (in comparison with a constant), so PHP doesn't cache the information and asks to the OS the env value per call.

So, if you are calling once per request, then there is not a problem. However, if you are calling it many times per request, then it could affects the performance.
up
16
php at keith tyler dot com
12 years ago
All of the notes and examples so far have been strictly CGI.
It should not be understated the usefulness of getenv()/putenv() in CLI as well.

You can pass a number of variables to a CLI script via environment variables, either in Unix/Linux bash/sh with the "VAR='foo'; export $VAR" paradigm, or in Windows with the "set VAR='foo'" paradigm. (Csh users, you're on your own!) getenv("VAR") will retrieve that value from the environment.

We have a system by which we include a file full of putenv() statements storing configuration values that can apply to many different CLI PHP programs. But if we want to override these values, we can use the shell's (or calling application, such as ant) environment variable setting method to do so.

This saves us from having to manage an unmanageable amount of one-off configuration changes per execution via command line arguments; instead we just set the appropriate env var first.
up
7
kyong
20 years ago
As you know, getenv('DOCUMENT_ROOT') is useful.
However, under CLI environment(I tend to do quick check
if it works or not), it doesn't work without modified php.ini
file. So I add "export DOCUMENT_ROOT=~" in my .bash_profile.
up
3
pritisn at gmail dot com
9 years ago
for quick check of getenv() adding a new env variable -
if you add a new env variable, make sure not only apache but xampp is also restarted.
Otherwise getenv() will return false for the newly added env variable.
up
2
Anonymous
5 years ago
It is worth noting that since getenv('MY_VARIABLE') will return false when the variable given is not set, there is no direct way to distinguish between a variable that is unset and one that is explicitly set to the value bool(false) when using getenv().
This makes it somewhat tricky to have boolean environment variables default to true if unset, which you can work around either by using "falsy" values such as 0 with the strict comparison operators or by using the superglobal arrays and isset().
up
0
sam at sambarrow dot com
16 years ago
SERVER_NAME is the name defined in the apache configuration.
HTTP_HOST is the host header sent by the client when using the more recent versions of the http protocol.
up
-1
hello at jabran dot me
9 years ago
Beware that when using this function with PHP built-in server – i.e. php -S localhost:8000 – it will return boolean FALSE.
up
-1
larby dot robert at gmail dot com
6 years ago
From PHP 7.1 => getenv() no longer requires its parameter. If the parameter is omitted, then the current environment variables will be returned as an associative array.

Source: http://php.net/manual/en/migration71.changed-functions.php
up
-2
chuck dot reeves at gmail dot com
14 years ago
When writing CLI applications, not that any environment variables that are set in your web server config will not be passed through. PHP will pass through system environment variables that are prefixed based off the safe_mode_allowed_env_vars directive in your php.ini
To Top