update_user_option( int $user_id, string $option_name, mixed $newvalue, bool $is_global = false )
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_id
-
(Required) User ID.
- $option_name
-
(Required) User option name.
- $newvalue
-
(Required) User option value.
- $is_global
-
(Optional) Whether option name is global or blog specific.<br> Default false (blog specific).
Default value: 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
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 );
}
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |