WordPress at Your Fingertips

update_user_option() WP 1.0

Update user option with global blog capability.

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.

No Hooks.

Return

Int|true|false. User meta ID if the option didn't exist, true on successful update, false on failure.

Usage

update_user_option( $user_id, $option_name, $newvalue, $global );
$user_id(int) (required)
User ID.
$option_name(string) (required)
User option name.
$newvalue(mixed) (required)
User option value.
$global(true|false)
Whether option name is global or blog specific.
Default: false (blog specific)

Notes

  • Global. wpdb. $wpdb WordPress database abstraction object.

Changelog

Since 2.0.0 Introduced.

Code of update_user_option() WP 5.8.1

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 );
}

Users

No comments
    Log In