_wp_connectors_get_api_key_source() — описание функции WordPress на русском

Сигнатура

_wp_connectors_get_api_key_source( string $setting_name, string $env_var_name = '', string $constant_name = '' ): string

Описание

Проверяет в следующем порядке: переменная окружения, PHP-константа, база данных.
Переменная окружения и константа проверяются только тогда, когда указаны их имена.

Оригинал (английский)

Checks in order: environment variable, PHP constant, database.
Environment variable and constant are only checked when their respective names are provided.

Параметры

$setting_name string обязательный

Имя опции для ключа API (например, 'connectors_spam_filtering_my_plugin_api_key').

$env_var_name string необязательный = ''

Имя проверяемой переменной окружения (например, 'MY_PLUGIN_API_KEY').

$constant_name string необязательный = ''

Имя проверяемой PHP-константы (например, 'MY_PLUGIN_API_KEY').

Возвращаемое значение

string

'env' 'constant' 'database' 'none'

Исходный код

wp-includes/connectors.php:440

function _wp_connectors_get_api_key_source( string $setting_name, string $env_var_name = '', string $constant_name = '' ): string {
	// Check environment variable first.
	if ( '' !== $env_var_name ) {
		$env_value = getenv( $env_var_name );
		if ( false !== $env_value && '' !== $env_value ) {
			return 'env';
		}
	}

	// Check PHP constant.
	if ( '' !== $constant_name && defined( $constant_name ) ) {
		$const_value = constant( $constant_name );
		if ( is_string( $const_value ) && '' !== $const_value ) {
			return 'constant';
		}
	}

	// Check database.
	$db_value = get_option( $setting_name, '' );
	if ( '' !== $db_value ) {
		return 'database';
	}

	return 'none';
}

История изменений

Версия	Описание
7.0.0	Introduced.