WordPress开发函数add_settings_error()

WordPress开发函数add_settings_error()，注册一个要显示给用户的设置错误。

用法：

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

描述

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

设置错误应该添加到register_setting()中定义的$ sanitie_callback函数中，以便对提交给出反馈。

默认情况下，消息将在生成错误的提交后立即显示。对settings_errors()的其他调用可以用于显示错误，即使在第一次访问设置页面时也是如此。

参数

$setting

(string) (必需) 插入应用此错误的设置的标题。

$code

(string) (必需) Slug-name用来识别错误。在HTML输出中用作’id’属性的一部分。

$message

(string) (必需) 格式化的消息文本显示给用户(将显示在样式和标签)。

$type

(string) (可选) 消息类型，控件HTML类。可能的值包括’error’， ‘success’， ‘warning’， ‘info’。

默认值: ‘error’

来源：

文件: wp-admin/includes/template.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,

);

}

更新日志：

用户贡献的笔记

（由Codex – 5年前贡献）

基本的例子

function change( $data ) {

$message = null;

$type = null;

if ( null != $data ) {

if ( false === get_option( ‘myOption’ ) ) {

add_option( ‘myOption’, $data );

$type = ‘updated’;

$message = __( ‘Successfully saved’, ‘my-text-domain’ );

} else {

update_option( ‘myOption’, $data );

$type = ‘updated’;

$message = __( ‘Successfully updated’, ‘my-text-domain’ );

}

} else {

$type = ‘error’;

$message = __( ‘Data can not be empty’, ‘my-text-domain’ );

}

add_settings_error(

‘myUniqueIdentifyer’,

esc_attr( ‘settings_updated’ ),

$message,

$type

);

}