update_user_meta


update_user_meta ( $user_id, $meta_key, $meta_value, $prev_value = '' )

Parameters:
  • (int) user_id User ID.
  • (string) meta_key Metadata key.
  • (mixed) meta_value Metadata value. Must be serializable if non-scalar.
  • (mixed) prev_value Optional. Previous value to check before updating. If specified, only update existing metadata entries with this value. Otherwise, update all entries. Default empty.
Links:
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.
Defined at:

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.

Related Functions

update_usermeta, update_site_meta, update_term_meta, update_user_status, delete_user_meta

Top Google Results

User discussions

wpseek mobile