wp_prime_option_caches_by_group() │ WP 6.4.0

Загружает в кеш все опции, зарегистрированные в указанной группе через register_setting().

Функция проверяет, какие опции уже есть в кеше. Затем одним запросом загружает из базы данных недостающие опции. Значения опций не возвращает.

Работает на основе: wp_prime_option_caches()

Хуков нет.

Возвращает

null.

  • void - ничего не возвращает.

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

wp_prime_option_caches_by_group( $option_group );
$option_group(string) (обязательный)
Название группы из первого параметра register_setting(). Опции группы должны быть зарегистрированы до вызова функции. Если группа не зарегистрирована, функция ничего не делает.

Примеры

#1 Загрузка опций страницы настроек в кеш

Регистрируем опции группы, а затем загружаем их в кеш только при открытии страницы плагина.

add_action( 'admin_init', 'myplugin_register_settings' );
add_action( 'load-settings_page_myplugin', 'myplugin_prime_settings_cache' );

function myplugin_register_settings() {
	register_setting( 'myplugin_settings', 'myplugin_api_url' );
	register_setting( 'myplugin_settings', 'myplugin_api_key' );
}

function myplugin_prime_settings_cache() {
	wp_prime_option_caches_by_group( 'myplugin_settings' );
}

Заметки

Global. Массив. $new_allowed_options

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

С версии 6.4.0 Введена.

Код wp_prime_option_caches_by_group() WP 7.1.2

function wp_prime_option_caches_by_group( $option_group ) {
	global $new_allowed_options;

	if ( isset( $new_allowed_options[ $option_group ] ) ) {
		wp_prime_option_caches( $new_allowed_options[ $option_group ] );
	}
}