wpseek.com
A WordPress-centric search engine for devs and theme authors



delete_user_setting › WordPress Function

Since2.7.0
Deprecatedn/a
› delete_user_setting ( $names )
Parameters:
  • (string) $names The name or array of names of the setting to be deleted.
    Required: Yes
Returns:
  • (bool|null) True if deleted successfully, false otherwise. Null if the current user is not a member of the site.
Defined at:
Codex:

Deletes user interface settings.

Deleting settings would reset them to the defaults. This function has to be used before any output has started as it calls setcookie().


Related Functions: delete_all_user_settings, get_user_setting, set_user_setting, delete_user_option, delete_user_meta

Source 

function delete_user_setting( $names ) {
	if ( headers_sent() ) {
		return false;
	}

	$all_user_settings = get_all_user_settings();
	$names             = (array) $names;
	$deleted           = false;

	foreach ( $names as $name ) {
		if ( isset( $all_user_settings[ $name ] ) ) {
			unset( $all_user_settings[ $name ] );
			$deleted = true;
		}
	}

	if ( $deleted ) {
		return wp_set_all_user_settings( $all_user_settings );
	}

	return false;
}