update_user_meta() WordPress Function

The update_user_meta() function allows you to update a user's meta data. The first parameter is the user ID, the second parameter is the meta key, and the third parameter is the meta value.

update_user_meta( int $user_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ) #

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.


Top ↑

Parameters

$user_id

(int)(Required)User ID.

$meta_key

(string)(Required)Metadata key.

$meta_value

(mixed)(Required)Metadata value. Must be serializable if non-scalar.

$prev_value

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

Default value: ''


Top ↑

Return

(int|bool) Meta ID if the key didn't exist, true on successful update, false on failure or if the value passed to the function is the same as the one that is already in the database.


Top ↑

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.


Top ↑

Source

File: wp-includes/user.php

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


Top ↑

Changelog

Changelog
VersionDescription
3.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