get_settings_errors( string $setting = '', bool $sanitize = false ): array[]
- Since
- 3.0.0
- Source
wp-admin/includes/template.php:1912
Description
Checks the $wp_settings_errors array for any errors declared during the current pageload and returns them.
If changes were just submitted ($_GET['settings-updated']) and settings errors were saved to the 'settings_errors' transient then those errors will be returned instead. This is used to pass errors back across pageloads.
Use the $sanitize argument to manually re-sanitize the option before returning errors.
This is useful if you have errors or notices you want to show even when the user hasn't submitted data (i.e. when they first load an options page, or in the 'admin_notices' action hook).
Compatibility
- WordPress
- since 3.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$settingstringoptional- Slug title of a specific setting whose errors you want.Default:
'' $sanitizebooloptional- Whether to re-sanitize the setting value before returning errors.Default:
false
Return value
array[]- Array of settings error arrays.
...$0arrayAssociative array of setting error data.$settingstringSlug title of the setting to which this error applies.$codestringSlug-name to identify the error. Used as part of 'id' attribute in HTML output.$messagestringThe 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'.
Performance profile
How much work a call to get_settings_errors() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Scales with input
- Instructions
- 10–42
- Plugin surface
- None
- Called by
- 1
Reads stored settings via get_option(), cached per request but not free on a cold cache.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 52.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - transienttransient
get_transient()called directly - hookthird-party callbacks
apply_filters()one call below get_settings_errors() - cacheobject cache
wp_cache_get()one call below get_settings_errors() - serializeserialisation
maybe_unserialize()one call below get_settings_errors()
Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_settings_errors() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10–19 | none |
isset($value) && !get_transient() | 17–23 | get_transient() |
| always | 17–26 | get_option(), sanitize_option() |
isset($value) && !get_transient() | 24–30 | get_option(), sanitize_option(), get_transient() |
isset($value) && get_transient() | 29–35 | get_transient(), get_transient(), array_merge(), delete_transient() |
isset($value) && get_transient() | 36–42 | get_option(), sanitize_option(), get_transient(), get_transient(), array_merge(), delete_transient() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 52 instructions, 10–42 executed per call, 9 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- sanitize_option()Sanitizes various option values based on the nature of the option.
- get_option()Retrieves an option value based on an option name.
- get_transient()Retrieves the value of a transient.
- delete_transient()Deletes a transient.
Used by · 1
- settings_errors()Displays settings errors registered by add_settings_error().
Source code
function get_settings_errors( $setting = '', $sanitize = false ) { global $wp_settings_errors; /* * If $sanitize is true, manually re-run the sanitization for this option * This allows the $sanitize_callback from register_setting() to run, adding * any settings errors you want to show by default. */ if ( $sanitize ) { sanitize_option( $setting, get_option( $setting ) ); } // If settings were passed back from options.php then use them. if ( isset( $_GET['settings-updated'] ) && $_GET['settings-updated'] && get_transient( 'settings_errors' ) ) { $wp_settings_errors = array_merge( (array) $wp_settings_errors, get_transient( 'settings_errors' ) ); delete_transient( 'settings_errors' ); } // Check global in case errors have been added on this pageload. if ( empty( $wp_settings_errors ) ) { return array(); } // Filter the results to those of a specific setting if one was set. if ( $setting ) { $setting_errors = array(); foreach ( (array) $wp_settings_errors as $key => $details ) { if ( $setting === $details['setting'] ) { $setting_errors[] = $wp_settings_errors[ $key ]; } } return $setting_errors; } return $wp_settings_errors;}Changelog
Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 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.