wp_get_environment_type() の使い方|説明・引数・注意点

説明

wp_get_environment_type() は、サイトの実行環境(本番、ステージングなど)を返す関数です。

基本構文

wp_get_environment_type(): string

引数

引数はありません。

戻り値

local / development / staging / production。

使い方(サンプル)

if ( 'production' !== wp_get_environment_type() ) {
	// 本番以外での処理
}

注意点

  • wp-config.php で WP_ENVIRONMENT_TYPE を定義します。未定義だと production になります。

実務での使いどころ

  • 本番・ステージングなど、環境によって、処理を切り替えるとき(デバッグ表示、解析タグの出力)。

よくあるミスと対処

  • 環境の種類の設定(WP_ENVIRONMENT_TYPE)がないと、production になる。
  • 設定を、最初の呼び出しより後に、定義している。最初の呼び出しの値が、保持される。
  • 環境の判定を、ドメイン名などで、自分で書いている。

NG例

if ( 'example.com' === $_SERVER['HTTP_HOST'] ) { // ドメイン名で判定している
	// 本番用の処理
}

OK例

if ( 'production' === wp_get_environment_type() ) {
	// 本番用の処理
}

使い分け早見表

値 意味
local ローカル環境
development 開発環境
staging ステージング環境
production 本番環境(既定)

関連項目

wp_get_theme()、wp_get_environment_type()

公式リファレンス:wp_get_environment_type() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました