delete_user_setting() │ WP 2.7.0

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().

No Hooks.

Return

true|false|null. True if deleted successfully, false otherwise. Null if the current user is not a member of the site.

Usage

delete_user_setting( $names );

$names(string) (required)

The name or array of names of the setting to be deleted.

Changelog

delete_user_setting() delete user setting code ^{WP 6.5.2}

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;
}