update_user_option( int $user_id, string $option_name, mixed $newvalue, bool $is_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 ‘is_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.
-
$is_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, $is_global = false ) {
global $wpdb;
if ( ! $is_global ) {
$option_name = $wpdb->get_blog_prefix() . $option_name;
}
return update_user_meta( $user_id, $option_name, $newvalue );
}
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Basic Example
Hide the admin bar for a user on the front end of the site:
When multisite is installed, the $global parameter can be used to set the user option for the whole network, instead of just the current site: