Функция update_site_option()
в WordPress предназначена для обновления значений опций, которые уже были добавлены для текущей сети блогов (мультисайта). Это позволяет администраторам управлять общими настройками, которые применяются ко всем сайтам в сети.
update_site_option( string $option, mixed $value ): bool
Эта функция позволяет обновить или добавить указанную опцию для текущего сайта в сети мультисайтов. Если функция используется в среде, где мультисайты не настроены, управление передается функции update_option()
с параметром $autoload = 'no'
. Обратите внимание, что начиная с версии 4.0, значения хранятся в таблице метаданных сети (wp_sitemeta
), а не в таблице опций текущего блога (wp_options
).
Параметры
- $option (строка) (обязательный): Название опции. Ожидается, что значение не будет SQL-экранировано.
- $value (смешанный) (обязательный): Значение опции. Ожидается, что значение не будет SQL-экранировано.
Возвращаемое значение
- bool: Возвращает
true
, если значение было обновлено, иfalse
в противном случае.
Пример 1: Обновление опции сети
В этом примере мы обновим значение опции сети, а затем получим его для отображения.
// Обновим опцию сети
update_site_option( 'example_network_option', 456 );
// Получаем и выводим значение опции
echo get_site_option( 'example_network_option' ); // > 456
Здесь мы создаем опцию с именем example_network_option
и присваиваем ей значение 456
. После этого используем get_site_option()
для получения и отображения значения.
Пример 2: Сохранение массива в опции сети
Если вам нужно сохранить массив в качестве значения опции, WordPress автоматически сериализует его перед сохранением.
// Создаем массив с настройками
$settings = array(
'color' => 'blue',
'size' => 'large',
);
// Сохраняем массив как опцию сети
update_site_option( 'my_settings_option', $settings );
// Получаем опцию и выводим один из значений
$options = get_site_option( 'my_settings_option' );
echo $options['color']; // > blue
В этом примере мы сохраняем массив с настройками и затем выводим одно из значений, которое было сохранено.
Пример 3: Проверка успешности обновления опции
Важно убедиться, что опция была успешно обновлена. Вы можете использовать условие для проверки результата функции.
// Обновляем опцию и проверяем результат
if ( update_site_option( 'check_option', 'Hello, World!' ) ) {
echo 'Опция успешно обновлена!';
} else {
echo 'Не удалось обновить опцию.';
}
Здесь мы обновляем опцию и проверяем, была ли она успешно обновлена. В зависимости от результата выводится соответствующее сообщение.
Заключение
Функция update_site_option()
является мощным инструментом для управления опциями в мультисайтовых установках WordPress. Она позволяет обновлять и добавлять параметры, которые могут быть использованы для настройки и управления сетевыми сайтами. Используя эту функцию, администраторы могут легко управлять глобальными настройками для всех сайтов в сети, обеспечивая целостность и согласованность данных.