On this page
update_user_option( int $user_id, string $option_name, mixed $newvalue, bool $global = false ): int|bool
Updates user option with global blog capability.
Description
User options are just like user metadata except that they have support for global blog options. If the ‘global’ parameter is false, which it is by default it will prepend the WordPress table prefix to the option name.
Deletes the user option if $newvalue is empty.
Parameters
$user_idint Required-
User ID.
$option_namestring Required-
User option name.
$newvaluemixed Required-
User option value.
$globalbool Optional-
Whether option name is global or blog specific.
Default false (blog specific).Default:
false
Return
int|bool User meta ID if the option didn't exist, true on successful update, false on failure.
Source
File: wp-includes/user.php. View all references
function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
global $wpdb;
if ( ! $global ) {
$option_name = $wpdb->get_blog_prefix() . $option_name;
}
return update_user_meta( $user_id, $option_name, $newvalue );
}
Related
Uses
| Uses | Description |
|---|---|
| update_user_meta() wp-includes/user.php | Updates user meta field based on user ID. |
| wpdb::get_blog_prefix() wp-includes/class-wpdb.php | Gets blog prefix. |
Used By
| Used By | Description |
|---|---|
| wp_dashboard_quick_press() wp-admin/includes/dashboard.php | The Quick Draft widget display and creation of drafts. |
| wp_user_settings() wp-includes/option.php | Saves and restores user interface settings stored in a cookie. |
| wp_set_all_user_settings() wp-includes/option.php | Private. Sets all user interface settings. |
| delete_all_user_settings() wp-includes/option.php | Deletes the user settings of the current user. |
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/update_user_option