当前浏览:首页 / WordPress函数 / get_settings_errors()

get_settings_errors( string $setting = '', bool $sanitize = false )

获取add_settings_error()注册的设置错误信息

error

settings 设置more...


描述

检查$wp_settings_errors数组中当前页面加载期间声明的任何错误,并返回这些错误。

如果更改刚刚提交($_GET[‘settings-updated’]),并且设置错误保存到‘settings_errors’瞬态(transient),则将返回这些错误。这用于跨页面加载传递错误。

在返回错误之前,使用$sanitize参数手动重新清理选项。如果即使用户尚未提交数据(即,当用户首次加载选项页面时,或在‘admin_notices’操作挂钩中),您也希望显示错误或通知,则此选项非常有用。


参数

$setting

(string)(可选) 您需要其错误的特定设置的slug标题。

默认值: ''

$sanitize

(bool)(可选) 是否在返回错误之前重新清理设置值。

默认值: false


返回

(array) 设置错误的数组。

  • 'setting'
    (string) 应用此错误的设置的slug标题。
  • 'code'
    (string) 用于识别错误的slug名称。用作HTML输出中'id'属性的一部分。
  • 'message'
    (string) 要向用户显示的格式化消息文本(将显示在样式化的<div><p>标记中)。
  • 'type'
    (string) 可选择的消息类型,它控制HTML类。可能的值包括'error'、'success'、'warning'、'info'。默认值为'error'。


源码

查看源码 官方文档


更新日志

版本描述
3.0.0开始引入