add_settings_error

Advertisement

Summery Summery

Register a settings error to be displayed to the user.

Syntax Syntax

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

Description Description

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.

Parameters Parameters

$setting

(string) (Required) Slug title of the setting to which this error applies.

$code

(string) (Required) Slug-name to identify the error. Used as part of 'id' attribute in HTML output.

$message

(string) (Required) The formatted message text to display to the user (will be shown inside styled <div> and <p> tags).

$type

(string) (Optional) Message type, controls HTML class. Possible values include 'error', 'success', 'warning', 'info'.

Default value: 'error'

Source Source

File: 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,
	);
}

Advertisement

Changelog Changelog

Changelog
Version Description
5.3.0 Added warning and info as possible values for $type.
3.0.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.