wpseek.com
A WordPress-centric search engine for devs and theme authors



update_user_option › WordPress Function

Since2.0.0
Deprecatedn/a
› update_user_option ( $user_id, $option_name, $newvalue, $is_global = false )
Parameters: (4)
  • (int) $user_id User ID.
    Required: Yes
  • (string) $option_name User option name.
    Required: Yes
  • (mixed) $newvalue User option value.
    Required: Yes
  • (bool) $is_global Optional. Whether option name is global or blog specific. Default false (blog specific).
    Required: No
    Default: false
Returns:
  • (int|bool) User meta ID if the option didn't exist, true on successful update, false on failure.
Defined at:
Codex:

Updates user option with global blog capability.

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.


Related Functions: update_site_option, update_option, delete_user_option, update_network_option, get_user_option

Source 

function update_user_option( $user_id, $option_name, $newvalue, $is_global = false ) {
	global $wpdb;

	if ( ! $is_global ) {
		$option_name = $wpdb->get_blog_prefix() . $option_name;
	}

	return update_user_meta( $user_id, $option_name, $newvalue );
}