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

getenvПолучает значение одной или всех переменных окружения


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

Функция получает значение одной или всех переменных окружения.

Список переменных окружения также выводит функция phpinfo(). Многие из этих переменных описывает раздел 4.1. Request Meta-Variables стандарта » RFC 3875.

Список параметров


Имя переменной в виде строки (string) или null.


Функция возвращает только локальные переменные окружения, которые установила операционная система или команда putenv, если для этого параметра установили значение true. Параметр повлияет на результат работы функции, только если значение параметра name — строка (string).

Возвращаемые значения

Функция возвращает значение переменной окружения name или false, если переменная окружения name не существует. Если значение параметра name равно null, функция возвращает все переменные окружения в виде ассоциативного массива (array).

Список изменений

Версия Описание
8.0.0 Параметр name теперь принимает значение null.
7.1.0 Теперь, чтобы получить ассоциативный массив (array) всех переменных окружения, параметр name можно не указывать.
7.0.9 Добавлен параметр local_only.


Пример #1 Пример использования функции getenv()


// Пример вызова функции getenv()
$ip = getenv('REMOTE_ADDR');

// Или просто получаем значение из суперглобальной переменной $_SERVER или $_ENV

// Надёжно получаем значение переменной окружения независимо от того,
// установили ли или нет значение через интерфейс SAPI или изменили командой putenv
$ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR');




Если PHP запустили через интерфейс SAPI наподобие Fast CGI, эта функция будет возвращать значения переменных окружения, которые установили через SAPI, даже если локальную переменную с таким же именем установили функцией putenv(). Устанавливайте параметр local_only, чтобы функция возвращала значение локальных переменных окружения.

Смотрите также

add a note

User Contributed Notes 14 notes

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

(getenv('path')); // bool(false)
var_dump(getenv('Path')); // bool(false)
var_dump(getenv('PATH')); // string(13) "/usr/bin:/bin"
7 years ago
As noted on, 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.
13 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') ?>
jcastromail at yahoo dot es
3 years ago
I did a benchmark about env.

constants :
0.00067687034606934 ms
getenv :
0.056761026382446 ms

(less is better)

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.
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.
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.
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().
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.
larby dot robert at gmail dot com
5 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.

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.
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.
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
jaraco at jaraco dot com
6 years ago
The example on how to fallback produces a syntax error on PHP 5.2:

-bash-3.2$ cat test.php

= getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR')


-bash-3.2$ /web/cgi-bin/php5 test.php
Content-type: text/html

<br />
<b>Parse error</b>: syntax error, unexpected ':' in <b>/home/content/25/11223125/test.php</b> on line <b>3</b><br />

On PHP 5.2, one must write

$ip = getenv('REMOTE_ADDR', true) ? getenv('REMOTE_ADDR', true) : getenv('REMOTE_ADDR')
f dot hartmann2 at gmx dot net
14 years ago
A function returning the remote adress of the visiting browser could look like this:

function getIPfromXForwarded() {
$addr = explode(",",$ipString);

Note that some adresses are followed by a whitespace and ip2long(getIPfromXForwarded()) would not return the expected result.

Make use of trim() in your scripts, either in the function itself, or the surrounding space of the caller.

To Top