getenv
(PHP 4, PHP 5, PHP 7, PHP 8)
getenv — 環境変数の値をひとつ、または全て取得する
説明
環境変数の値をひとつ、または全て取得します。
phpinfo() を使えば、すべての環境変数の一覧を見ることができます。 これらの変数の多くは、 » RFC 3875 の section 4.1, "Request Meta-Variables" に挙げられているものです。
パラメータ
変更履歴
| バージョン | 説明 |
|---|---|
| 8.0.0 |
name は、nullable になりました。
|
| 7.1.0 |
name は、すべての環境変数の連想配列を取得するために
省略することができるようになりました。
|
| 7.0.9 |
local_only パラメーターが追加されました。
|
例
例1 getenv() の例
<?php
// getenv() の使用例
$ip = getenv('REMOTE_ADDR');
// または単純にスーパーグローバル（$_SERVER または $_ENV）を使用します
$ip = $_SERVER['REMOTE_ADDR'];
// SAPI により設定されたか、または putenv により変更されたかどうかを無視して
// 環境変数の値を安全に取得します。
$ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR')
?>注意
警告
PHP が Fast CGI のような SAPI で実行中の場合、
同じ名前のローカル環境変数を設定するために putenv() が使用されても、
この関数は SAPI により設定された環境変数の値を常に返します。
ローカル設定された環境変数の値を返すには、
local_only パラメーターを使用してください。
＋add a note
User Contributed Notes 12 notes
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"
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.
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') ?>
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.
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.
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.
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.
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().
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.
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
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