Описание функции get_theme_mod()
Функция get_theme_mod() используется для получения настроек темы WordPress, которые были сохранены с помощью функции set_theme_mod(). Она позволяет разработчикам тем получать значения настроек, установленных пользователем в панели управления.
Эта функция обычно используется в темах, чтобы извлекать пользовательские настройки и применять их к элементам интерфейса, таким как цвета, шрифты и другие параметры внешнего вида.
Параметры
$name
Тип: string
Обязательный: Да
По умолчанию: null
Описание: Ключ настройки темы, значение которой нужно получить
Возможные значения:
$default
Тип: mixed
Обязательный: Нет
По умолчанию: null
Описание: Значение по умолчанию, которое будет возвращено, если настройка не найдена
Возможные значения:
Возвращаемое значение
Тип: mixed
Описание: Значение настройки темы или значение по умолчанию
Возможные значения:
• Настройка темы, если она существует
• Значение по умолчанию, если настройка не найдена
• null, если настройка не существует и значение по умолчанию не указано
Примеры использования
Базовый пример получения цвета заголовка
$header_color = get_theme_mod('header_color', '#FFFFFF');
// Используем $header_color для стилизации заголовка
Если настройка не задана, будет возвращен ‘#FFFFFF’
Получение текста для подвала с значением по умолчанию
$footer_text = get_theme_mod('footer_text', 'Default footer text');
// Выводим текст в подвале
Если настройка не задана, будет возвращен ‘Default footer text’
Безопасность
Валидация входных данных: Функция не требует ручной валидации входных параметров
Санитизация: Сохраненные значения очищаются WordPress
Рекомендации: При выводе данных используйте esc_html() для текстовых значений
— Связанные функции
Сохраняет значение настройки темы
Удаляет сохраненное значение настройки темы
— Хуки
Фильтрует все настройки темы перед возвратом
Фильтрует конкретную настройку темы перед возвратом
— Примечания
– Ограничения
Функция возвращает только настройки, установленные через set_theme_mod()
– Частые проблемы
- Возвращает null, если настройка не найдена и значение по умолчанию не указано
- Ошибки могут возникнуть при неправильном названии ключа настройки