PHP環境変数の使いどころ

PHP環境変数の使いどころについて聞かれることがあります。
本記事では、PHP環境変数の便利な使い方についてご紹介します。
サポートサイトのPHP環境変数も合わせてご確認ください。

PHP環境変数は、サイト側のPHPで利用する値をセットしておき、PHPプログラム内で自由に呼び出せる機能です。
テスト環境と本番環境ごとに値を設定しておくことで、アクセス時に環境ごとに値が自動で切り替わります。
[イメージ図]

PHP環境変数を使用する際は、PHPで

getEnvValue($key)

の関数を使って呼び出します。
サポートサイトのgetEnvValue($key)をご参照ください。

ページ内でAPIを利用する際にアプリIDやDB IDを登録しておくことで、複数ページでIDを共通で呼び出すことが可能になります。
ナレッジサイトに公開されているAPIを利用するサンプルプログラムは、APIキーをPHP環境変数に登録し、使用しています。

外部サービスと連携を行う場合にテスト環境用と本番環境用で、APIキーやエンドポイントが分かれていることがあります。
PHP環境変数に設定しておくことで、リリース時に書き換え等不要で運用できます。

フォームに外部チャットツールへの通知する場合など、絶対パスでURLを送信する必要がある場合に利用します。

PHP環境変数にテスト環境「true」、本番環境「false」で設定します。
登録フォームにテスト環境用フラグを準備し、「true」の場合のみ任意の値を登録する形にすることで、
テスト環境から登録された場合のみ、テスト環境フラグを立てることも可能です。

他の活用方法が知りたい等あれば、下記の「コンテンツに関しての要望はこちら」からご連絡ください。

設計情報