putenv

関数の概要

PHPの putenv 関数は、環境変数を設定するために使われます。環境変数はオペレーティングシステムやその他のプログラムに影響を与えるため、実行環境の設定や動的な設定変更に便利です。putenv を利用すると、スクリプト実行中に新しい環境変数を追加したり、既存の環境変数の値を変更したりできます。

パラメータの説明

  • string $setting — 設定したい環境変数の名前と値を NAME=VALUE の形式で指定します。

戻り値

関数は環境変数の設定に成功した場合に true を返し、失敗した場合は false を返します。しかし、環境や設定によっては必ずしも期待通り動作しない場合があるため、戻り値の確認は推奨されます。

使用例

基本的な使い方

putenv("APP_ENV=production");
echo getenv("APP_ENV");  // 出力: production

環境変数 APP_ENVproduction に設定し、getenv で値を取得しています。

既存の環境変数を上書きする例

putenv("PATH=/usr/local/bin");
echo getenv("PATH");  // 出力: /usr/local/bin

既存の PATH 環境変数の値を上書きしています。注意点として、環境変数はシステム全体の挙動に影響する場合があるため、慎重に設定しましょう。

環境変数の削除方法

putenv("MY_VAR");  // MY_VARを削除
var_dump(getenv("MY_VAR"));  // 出力: false(存在しないことを示す)

値を指定せずに putenv を呼び出すことで、環境変数を削除(アンセット)することができます。

関連する関数

  • getenv() – 指定した環境変数の値を取得する
  • $_ENV – 環境変数のスーパーグローバル配列
  • apache_setenv() – Apache環境用に環境変数を設定する(Webサーバー使用時)

まとめ

putenv はPHPスクリプト内で環境変数を動的に設定・変更するために便利な関数です。特に環境ごとに挙動を変えたい場合や外部ツールとの連携時に役立ちます。ただし他のプログラムやシステム全体に影響を与える可能性があるため、使用時には設定内容や適用範囲を理解して慎重に扱うことが重要です。