wp_get_environment_type() WP 5.5.0

Получает текущий тип окружения: local, development, staging, production (по умолчанию).

Установка типа окружения

Тип окружения может быть задан двумя способами: с помощью глобальной системной переменной WP_ENVIRONMENT_TYPE или константы с таким же именем.

putenv( 'WP_ENVIRONMENT_TYPE=development' );

// или
define( 'WP_ENVIRONMENT_TYPE', 'development' );

Значение константы, переписывает значение системной переменной. Если указано значение не из списка выше, то функция вернет тип production.

Хуков нет.

Возвращает

Строку. Текущий тип окружения:

• local — локалка. C версии 5.5.1
• development — разработка.
• staging — ветка, стадия, тестирование.
• production — рабочий сайт (по умолчанию).

Использование

wp_get_environment_type();

Примеры

#1 Пример из Ядра - дефолтная установка константы WP_DEBUG

if ( ! defined( 'WP_DEBUG' ) ) {
	if ( 'development' === wp_get_environment_type() ) {
		define( 'WP_DEBUG', true );
	} else {
		define( 'WP_DEBUG', false );
	}
}

#2 Еще демонстрационный пример

switch ( wp_get_environment_type() ) {
	case 'local':
	case 'development':
		do_nothing();
		break;

	case 'staging':
		do_staging_thing();
		break;

	case 'production':
	default:
		do_production_thing();
		break;
}

Список изменений

Код wp_get_environment_type() wp get environment type ^{WP 5.6.2}

<?php
function wp_get_environment_type() {
	static $current_env = '';

	if ( $current_env ) {
		return $current_env;
	}

	$wp_environments = array(
		'local',
		'development',
		'staging',
		'production',
	);

	// Add a note about the deprecated WP_ENVIRONMENT_TYPES constant.
	if ( defined( 'WP_ENVIRONMENT_TYPES' ) && function_exists( '_deprecated_argument' ) ) {
		if ( function_exists( '__' ) ) {
			/* translators: %s: WP_ENVIRONMENT_TYPES */
			$message = sprintf( __( 'The %s constant is no longer supported.' ), 'WP_ENVIRONMENT_TYPES' );
		} else {
			$message = sprintf( 'The %s constant is no longer supported.', 'WP_ENVIRONMENT_TYPES' );
		}

		_deprecated_argument(
			'define()',
			'5.5.1',
			$message
		);
	}

	// Check if the environment variable has been set, if `getenv` is available on the system.
	if ( function_exists( 'getenv' ) ) {
		$has_env = getenv( 'WP_ENVIRONMENT_TYPE' );
		if ( false !== $has_env ) {
			$current_env = $has_env;
		}
	}

	// Fetch the environment from a constant, this overrides the global system variable.
	if ( defined( 'WP_ENVIRONMENT_TYPE' ) ) {
		$current_env = WP_ENVIRONMENT_TYPE;
	}

	// Make sure the environment is an allowed one, and not accidentally set to an invalid value.
	if ( ! in_array( $current_env, $wp_environments, true ) ) {
		$current_env = 'production';
	}

	return $current_env;
}

Cвязанные функции

Из метки: debug (дебаг)

Еще из раздела: Опции сайта (настройки)