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

Description

Parameters

$settingstring

Slug title of the setting to which this error applies.

$codestring

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

$messagestring

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

$typestringoptional

Message type, controls HTML class. Possible values include 'error', 'success', 'warning', 'info'. Default 'error'.Default: 'error'

Used by · 3

• WP_Privacy_Requests_Table::process_bulk_action()Process bulk actions.
• _wp_personal_data_handle_actions()Handle list table actions.
• sanitize_option()Sanitizes various option values based on the nature of the option.

Source

View on Trac ↗View on GitHub ↗

1868function add_settings_error( $setting, $code, $message, $type = 'error' ) {1869	global $wp_settings_errors;1870 1871	$wp_settings_errors[] = array(1872		'setting' => $setting,1873		'code'    => $code,1874		'message' => $message,1875		'type'    => $type,1876	);1877}

History

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.