getenv

(PHP 4, PHP 5, PHP 7)

getenv — 環境変数の値を取得する

説明

getenv ( string $varname [, bool $local_only = FALSE ] ) : string
getenv ( void ) : array

環境変数の値を取得します。

phpinfo() を使えば、すべての環境変数の一覧を見ることができます。 これらの変数の多くは、 » RFC 3875 の section 4.1, "Request Meta-Variables" に挙げられているものです。

パラメータ

varname

変数の名前。

local_only

true に設定すると、(OS または putenv により設定された) ローカルの環境変数のみを返します。

返り値

varname が示す環境変数の値を返し、 環境変数 varname が存在しない場合はFALSEを返します。 varname が省略された場合、 すべての環境変数は連想配列として返されます。

変更履歴

バージョン 説明
7.1.0 varname は、すべての環境変数の連想配列を取得するために 省略することができるようになりました。
5.5.38, 5.6.24, 7.0.9 local_only パラメーターが追加されました。

注意

警告

PHP が Fast CGI のような SAPI で実行中の場合、 同じ名前のローカル環境変数を設定するために putenv() が使用されても、 この関数は SAPI により設定された環境変数の値を常に返します。 ローカル設定された環境変数の値を返すには、 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')
?>

参考