描述
这是设置API的一部分。为get_settings_errors()检索到的每个错误输出一个div。
提交基于设置API的设置页面后，将自动调用此函数。对于register_setting()中定义的设置，应在验证回调函数期间添加错误。
$sanitize选项被传递到get_settings_errors()中，并将根据其当前值重新运行设置清理。
$hide_on_update选项将导致仅在首次加载设置页面时显示错误。如果用户已保存新值，则将隐藏该值，以避免在提交后重复默认错误报告中已显示的消息。这有助于在用户到达设置页面时显示一般错误，如缺少设置。
参数
- $setting
-
(string)(可选) 您需要其错误的特定设置的slug标题。
默认值: ''
- $sanitize
-
(bool)(可选) 是否在返回错误之前重新清理设置值。
默认值: false
- $hide_on_update
-
(bool)(可选) 如果设置为true，则如果已提交设置页面，则不会显示错误。
默认值: false
源码
更新日志
| 版本 | 描述 |
|---|---|
| 5.3.0 | 遗留的error和updatedCSS类映射到notice-error与notice-success。 |
| 3.0.0 | 开始引入 |
使用示例
实例
/** * Displays all messages registered to 'your-settings-error-slug' */ function wpdocs_your_admin_notices_action() { settings_errors( 'your-settings-error-slug' ); } add_action( 'admin_notices', 'wpdocs_your_admin_notices_action' );