add_settings_error() — описание функции WordPress на русском

Сигнатура

add_settings_error( string $setting, string $code, string $message, string $type = 'error' )

Описание

Часть Settings API. Используется для показа пользователям сообщений о проблемах валидации настроек, отсутствующих настройках и о чём угодно ещё.
Ошибки настроек следует добавлять внутри функции $sanitize_callback , определённой в register_setting() для конкретной настройки, чтобы дать обратную связь об отправке.
По умолчанию сообщения отображаются сразу после отправки, вызвавшей ошибку.
Дополнительные вызовы settings_errors() можно использовать для показа ошибок даже при первом открытии страницы настроек.

Оригинал (английский)

Part of the Settings API. Use this to show messages to users about settings validation problems, missing settings or anything else.

Settings errors should be added inside the $sanitize_callback function defined in register_setting() for a given setting to give feedback about the submission.

By default messages will show immediately after the submission that generated the error.
Additional calls to settings_errors() can be used to show errors even when the settings page is first accessed.

Параметры

$setting string обязательный

Слаг настройки, к которой относится эта ошибка.

$code string обязательный

Слаг для идентификации ошибки. Используется как часть атрибута 'id' в HTML-выводе.

$message string обязательный

Отформатированный текст сообщения для отображения пользователю (показывается внутри стилизованных тегов

и

).

$type string необязательный = 'error'

Тип сообщения, управляет HTML-классом. Возможные значения: 'error', 'success', 'warning', 'info'. Значение по умолчанию 'error'.

Исходный код

wp-admin/includes/template.php:1870

function add_settings_error( $setting, $code, $message, $type = 'error' ) {
	global $wp_settings_errors;

	$wp_settings_errors[] = array(
		'setting' => $setting,
		'code'    => $code,
		'message' => $message,
		'type'    => $type,
	);
}

История изменений

Версия	Описание
5.3.0	Added warning and info as possible values for $type.
3.0.0	Introduced.