delete_user_setting( string $names ): bool|null
Deletes user interface settings.
Description
Deleting settings would reset them to the defaults.
This function has to be used before any output has started as it calls setcookie().
Parameters
-
$namesstring Required -
The name or array of names of the setting to be deleted.
Return
bool|null True if deleted successfully, false otherwise.
Null if the current user is not a member of the site.
Source
File: wp-includes/option.php.
View all references
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;
}
Changelog
| Version | Description |
|---|---|
| 2.7.0 | Introduced. |