Описание функции get_network_option()
Функция get_network_option() используется для получения значений опций сети в мультисайтовом WordPress. Она позволяет извлекать значения опций, которые хранятся в базе данных для сети, обеспечивая единую точку доступа для всех сайтов в сети.
Это полезно для настройки общих параметров, таких как настройки сети, ограничения и другие параметры, применимые ко всем сайтам в мультисайте.
Параметры
$network_id
Тип: int
Обязательный: Да
Описание: ID сети, для которой нужно получить опцию
Возможные значения:
range: положительные целые числа, соответствующие ID сети
$option
Тип: string
Обязательный: Да
Описание: Ключ опции, которую нужно получить
Возможные значения:
example: site_name
$default
Тип: mixed
Обязательный: Нет
Описание: Значение по умолчанию, если опция не найдена
Возможные значения:
type: любой тип данных
Возвращаемое значение
Тип: mixed
Описание: Значение опции сети, или значение по умолчанию, если опция не найдена
Возможные значения:
• Значение опции, если она существует
• Значение по умолчанию, если опция не найдена
• false, если произошла ошибка
Примеры использования
Базовый пример получения сетевой опции по ID сети
$network_id = 1;
$option_value = get_network_option($network_id, 'site_name');
// Вывод значения опции
echo $option_value;
Выводит имя сайта для сети с ID 1
Получение значения опции, которая не существует, с указанием значения по умолчанию
$network_id = 1;
$option_value = get_network_option($network_id, 'non_existing_option', 'default_value');
// Вывод значения по умолчанию
echo $option_value;
Выводит ‘default_value’
Безопасность
Валидация входных данных: ID сети и ключ опции проверяются на корректность
Санитизация: Функция автоматически очищает входные параметры
Рекомендации: При выводе данных используйте esc_html() для безопасного отображения значений опций
— Связанные функции
Обновляет значение сетевой опции
Удаляет сетевую опцию
— Хуки
Фильтрует значения опций перед их возвратом
— Примечания
– Ограничения
Функция работает только в контексте мультисайтовой установки WordPress
– Частые проблемы
- Неверный ID сети приведет к ошибке
- Отсутствие опции вернет false, если не указано значение по умолчанию