関数・クラス解説

getenv

version:PHP 4, PHP 5, PHP 7 (公式)

環境変数の値を取得する

公式リファレンス

書式

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

getenv ( ) : array

説明

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

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

パラメータ

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

返値

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

注意

警告 PHP が Fast CGI のような SAPI で実行中の場合、 同じ名前のローカル環境変数を設定するために putenv() が使用されても、 この関数は SAPI により設定された環境変数の値を常に返します。 ローカル設定された環境変数の値を返すには、 local_only パラメーターを使用してください。警告 PHP が Fast CGI のような SAPI で実行中の場合、 同じ名前のローカル環境変数を設定するために putenv() が使用されても、 この関数は SAPI により設定された環境変数の値を常に返します。 ローカル設定された環境変数の値を返すには、 local_only パラメーターを使用してください。

更新履歴

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

サンプル

例1 getenv() の例

// getenv() の使用例 $ip = getenv('REMOTE_ADDR'); // または単純にスーパーグローバル($_SERVER または $_ENV)を使用します $ip = $_SERVER['REMOTE_ADDR']; // SAPI により設定されたか、または putenv により変更されたかどうかを無視して // 環境変数の値を安全に取得します。 $ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR')

参考

  • putenv() - 環境変数の値を設定する
  • apache_getenv() - Apache の subprocess_env 変数を取得する
  • スーパーグローバル
  • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール