注册要显示给用户的设置错误

原型

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

描述

Settings API的一部分。使用此选项向用户显示有关设置验证问题,缺少设置或其他任何内容的消息。

参数

$setting (string) (Required) 此错误适用的设置的Slug标题

$code (string) (Required) Slug-name来识别错误。用作HTML输出中“id”属性的一部分。

$message (string) (Required) 要显示给用户的格式化消息文本(将显示在样式和标记内)。

$type (string) (Optional)  消息类型,控制HTML类。接受’错误’或’更新’。

源文件

路径:wp-admin/includes/template.php

<?php
...
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
	);
}
...
?>

其他

英文文档:https://developer.wordpress.org/reference/functions/add_settings_error/