update_user_option() WordPress Function

The update_user_option() function is used to update a user meta field with new value. The function takes three parameters: the user ID, the meta key to update, and the new value to set. This function is typically used when a user updates their settings on a Wordpress site. For example, if a user changes their display name, the update_user_option() function would be used to update the “display_name” meta key with the new value.

update_user_option( int $user_id, string $option_name, mixed $newvalue, bool $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 ‘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.


Top ↑

Parameters

$user_id

(int)(Required)User ID.

$option_name

(string)(Required)User option name.

$newvalue

(mixed)(Required)User option value.

$global

(bool)(Optional) Whether option name is global or blog specific. Default false (blog specific).

Default value: false


Top ↑

Return

(int|bool) User meta ID if the option didn't exist, true on successful update, false on failure.


Top ↑

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


Top ↑

Changelog

Changelog
VersionDescription
2.0.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More