W3cubDocs

/WordPress

update_user_option( int $user_id, string $option_name, mixed $newvalue, bool $global = false )

Update 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.

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

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

Used By

Used By Description
wp-includes/script-loader.php: wp_localize_community_events()

Localizes community events data that needs to be passed to dashboard.js.
wp-admin/includes/ajax-actions.php: wp_ajax_get_community_events()

Handles Ajax requests for community events
wp-admin/includes/dashboard.php: wp_dashboard_quick_press()

The Quick Draft widget display and creation of drafts.
wp-admin/includes/upgrade.php: wp_install()

Installs the site.
wp-admin/includes/user.php: default_password_nag_handler()
wp-admin/includes/user.php: default_password_nag_edit_user()
wp-admin/includes/ajax-actions.php: wp_ajax_closed_postboxes()

Ajax handler for closed post boxes.
wp-admin/includes/ajax-actions.php: wp_ajax_hidden_columns()

Ajax handler for hidden columns.
wp-admin/includes/ajax-actions.php: wp_ajax_meta_box_order()

Ajax handler for saving the meta box order.
wp-admin/includes/nav-menu.php: wp_nav_menu_setup()

Register nav menu meta boxes and advanced menu items.
wp-admin/includes/nav-menu.php: wp_initial_nav_menu_meta_boxes()

Limit the amount of meta boxes to pages, posts, links, and categories for first time users.
wp-includes/option.php: wp_user_settings()

Saves and restores user interface settings stored in a cookie.
wp-includes/option.php: wp_set_all_user_settings()

Private. Sets all user interface settings.
wp-includes/option.php: delete_all_user_settings()

Deletes the user settings of the current user.
wp-includes/user.php: reset_password()

Handles resetting the user’s password.
wp-includes/user.php: register_new_user()

Handles registering a new user.

Changelog

Version Description
2.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/update_user_option