Описание функции add_settings_error()
Функция add_settings_error() добавляет ошибку в список ошибок для заданной группы настроек в WordPress. Она используется для отображения сообщений об ошибках при сохранении настроек, что позволяет пользователю видеть, что что-то пошло не так. Эта функция часто применяется в админ-панели при работе с настройками плагинов и тем.
Ошибки могут быть отображены с помощью функции settings_errors()
Параметры
$setting
Тип: string
Обязательный: Да
Описание: Уникальное имя настройки, к которой привязана ошибка
Возможные значения:
$code
Тип: string
Обязательный: Да
Описание: Уникальный код ошибки для идентификации
Возможные значения:
$message
Тип: string
Обязательный: Да
Описание: Сообщение об ошибке, которое будет отображено
Возможные значения:
$type
Тип: string
Обязательный: Нет
По умолчанию: ‘error’
Описание: Тип сообщения: ‘error’, ‘updated’ или ‘warning’
Возможные значения:
0: error
1: updated
2: warning
Возвращаемое значение
Тип: void
Описание: Функция ничего не возвращает
Возможные значения:
• void
Примеры использования
Добавление простой ошибки к настройке
add_settings_error('my_setting', 'error_code_1', 'Произошла ошибка при сохранении настройки.');
Ошибка будет привязана к настройке с именем ‘my_setting’
Добавление предупреждения для настройки
add_settings_error('my_setting', 'warning_code', 'Это предупреждение, проверьте ваши настройки.', 'warning');
Сообщение будет отображено как предупреждение
Добавление ошибки в зависимости от условия
if ($some_condition) { add_settings_error('my_setting', 'error_code', 'Настройка не была сохранена.'); }
Ошибка будет добавлена, если условие истинно
Использование в функции сохранения настроек плагина
function my_plugin_settings_save() { if (!valid_data($data)) { add_settings_error('my_setting', 'invalid_data', 'Данные невалидны.'); } }
Ошибка будет добавлена, если данные невалидны
Безопасность
Валидация входных данных: Параметры должны быть валидными строками
Санитизация: Необходима ручная очистка сообщений перед использованием
Рекомендации: Используйте esc_html() для сообщений об ошибках перед выводом
— Связанные функции
Отображает все ошибки и уведомления, связанные с настройками
Регистрирует настройку для использования в админ-панели
— Примечания
– Ограничения
Ошибки хранятся только до следующего запроса
– Частые проблемы
- Ошибка не отображается, если settings_errors() не вызывается
- Несоответствие кодов и сообщений
