Updates user meta field based on user ID.

Description

Use the $prev_value parameter to differentiate between meta fields with the same key and user ID.

If the meta field for the user does not exist, it will be added.

Parameters

$user_idintrequired

User ID.

$meta_keystringrequired

Metadata key.

$meta_valuemixedrequired

Metadata value. Must be serializable if non-scalar.

$prev_valuemixedoptional

Previous value to check before updating.
If specified, only update existing metadata entries with this value. Otherwise, update all entries.

Default:''

Return

More Information

Changes in behavior from the now deprecated update_usermeta:

Update_user_meta does not delete the meta if the new value is empty.

The actions are different.

Source

function update_user_meta( $user_id, $meta_key, $meta_value, $prev_value = '' ) {
	return update_metadata( 'user', $user_id, $meta_key, $meta_value, $prev_value );
}

View all references View on Trac View on GitHub

Changelog