delete_user_setting( string $names )
Delete user interface settings.
Description 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 Parameters
- $names
-
(string) (Required) The name or array of names of the setting to be deleted.
Return Return
(bool|null) True if deleted successfully, false if not. Null if the current user can't be established.
Source Source
File: wp-includes/option.php
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; }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |