set_user_setting( string $name, string $value )
Add or update user interface setting.
Description
Both $name and $value can contain only ASCII letters, numbers and underscores.
This function has to be used before any output has started as it calls setcookie().
Parameters
- $name
-
(Required) The name of the setting.
- $value
-
(Required) The value for the setting.
Return
(bool|null) True if set successfully, false if not. Null if the current user can't be established.
Source
File: wp-includes/option.php
function set_user_setting( $name, $value ) {
if ( headers_sent() ) {
return false;
}
$all_user_settings = get_all_user_settings();
$all_user_settings[$name] = $value;
return wp_set_all_user_settings( $all_user_settings );
}
Changelog
| Version | Description |
|---|---|
| WP-2.8.0 | Introduced. |