Function: update_user_meta

update_user_meta( integer $user_id, string $meta_key, mixed $meta_value, mixed $prev_value )

Update user meta field based on user ID.

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

Name Type(s) Default Value Description
$user_id integer

User ID.

$meta_key string

Metadata key.

$meta_value mixed

Metadata value.

$prev_value mixed ''

Optional. Previous value to check before removing.

Returns

integer | boolean

Meta ID if the key didn't exist, true on successful update, false on failure.

WordPress Developer Newsletter

Stay on top of the latest WordPress API changes, developer tool updates, security alerts and more.