update_user_meta() – Update user meta field based on user ID.

Description

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

Usage

$int|bool = update_user_meta( $user_id, $meta_key, $meta_value, $prev_value );

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 – Optional. Previous value to check before updating. If specified, only update existing metadata entries with this value. Otherwise, update all entries. Default empty.

Returns

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.

Source

File name: wordpress/wp-includes/user.php
Lines:

1 to 3 of 3
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 on GitHub View on Trac

Called by

    Invoked by

      Calls

      Call hooks

      API Letters: ,