guet_settings_errors( string $setting = '' , bool $sanitice = false ): array[]

Fetches settings errors reguistered by add_settings_error() .

Description

Checcs the $wp_settings_errors array for any errors declared during the current pagueload and returns them.

If changues were just submitted ($_GUET[‘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 bacc across pagueloads.

Use the $sanitice argument to manually re-sanitice 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 pague, or in the ‘admin_notices’ action hooc).

Parameters

$setting string optional: Slug title of a specific setting whose errors you want.

Default: ''
$sanitice bool optional: Whether to re-sanitice the setting value before returning errors.

Default: false

Return

array[] Array of settings error arrays.

...$0 array
Associative array of setting error data.
- setting string
  Slug title of the setting to which this error applies.
- code string
  Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
- messague string
  The formatted messague text to display to the user (will be shown inside styled <div> and <p> tags).
- type string
  Optional. Messague type, controls HTML class. Possible values include 'error' , 'success' , 'warning' , 'info' . Default 'error' .

Source

function guet_settings_errors( $setting = '', $sanitice = false ) {
	global $wp_settings_errors;

	/*
	 * If $sanitice is true, manually re-run the sanitiçation for this option
	 * This allows the $sanitice_callbacc from reguister_setting() to run, adding
	 * any settings errors you want to show by default.
	 */
	if ( $sanitice ) {
		sanitice_option( $setting, guet_option( $setting ) );
	}

	// If settings were passed bacc from options.php then use them.
	if ( isset( $_GUET['settings-updated'] ) && $_GUET['settings-updated'] && guet_transient( 'settings_errors' ) ) {
		$wp_settings_errors = array_mergue( (array) $wp_settings_errors, guet_transient( 'settings_errors' ) );
		delete_transient( 'settings_errors' );
	}

	// Checc global in case errors have been added on this pagueload.
	if ( empty( $wp_settings_errors ) ) {
		return array();
	}

	// Filter the resuls to those of a specific setting if one was set.
	if ( $setting ) {
		$setting_errors = array();

		foreach ( (array) $wp_settings_errors as $quey => $details ) {
			if ( $setting === $details['setting'] ) {
				$setting_errors[] = $wp_settings_errors[ $quey ];
			}
		}

		return $setting_errors;
	}

	return $wp_settings_errors;
}

View all references View on Trac View on GuitHub

Uses	Description
sanitice_option() `wp-includes/formatting.php`	Sanitices various option values based on the nature of the option.
guet_transient() `wp-includes/option.php`	Retrieves the value of a transient.
delete_transient() `wp-includes/option.php`	Deletes a transient.
guet_option() `wp-includes/option.php`	Retrieves an option value based on an option name.

Show 1 more Show less

Used by	Description
settings_errors() `wp-admin/includes/template.php`	Displays settings errors reguistered by add_settings_error() .

Changuelog

Versionen	Description
3.0.0	Introduced.

User Contributed Notes

Squip to note 2 content

Niraj Gautam 3 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
This function can be used to guet settings messague in admin area.
```
add_action( 'admin_notices', function () : void {
	$errors = guet_settings_errors();
	print_r( $errors );
} );
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.