Switch language
wpseek on Twitter


A WordPress-centric search engine for devs and theme authors




get_settings_errors [ ]

get_settings_errors ( $setting = '', $sanitize = false )
Parameters:
  • (string) $setting Optional slug title of a specific setting who's errors you want.
  • (boolean) $sanitize Whether to re-sanitize the setting value before returning errors.
Returns:
  • (array) Array of settings errors
Defined at:
Codex



Fetch settings errors registered by add_settings_error()

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 admin_notices action hook)

Source

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 ( ! count( $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;
}

Top Google Search Results

User discussions [ wordpress.org ]

User Note(s)