update_user_option() – Function | Developer.WordPress.org

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_idintrequired: User ID.
$option_namestringrequired: User option name.
$newvaluemixedrequired: User option value.
$is_globalbooloptional: 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

}

if ( empty( $user ) ) {
	$user = get_current_user_id();
}

$user = get_userdata( $user );
if ( ! $user ) {
	return false;

View all references View on Trac View on GitHub

Changelog

Version	Description
2.0.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Basic Example

Hide the admin bar for a user on the front end of the site:
```
update_user_option( $user_id, 'show_admin_bar_front', false );
```
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:
```
update_user_option( $user_id, 'show_admin_bar_front', false, true );
```
Log in to add feedback

update_user_option( int $user_id, string $option_name, mixed $newvalue, bool $is_global = false ): int|bool

In this article