wpseek.com
A WordPress-centric search engine for devs and theme authors



update_user_meta › WordPress Function

Since3.0.0
Deprecatedn/a
› update_user_meta ( $user_id, $meta_key, $meta_value, $prev_value = '' )
Parameters: (4)
  • (int) $user_id User ID.
    Required: Yes
  • (string) $meta_key Metadata key.
    Required: Yes
  • (mixed) $meta_value Metadata value. Must be serializable if non-scalar.
    Required: Yes
  • (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.
    Required: No
    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:
Codex:

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. For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input.


Related Functions: update_usermeta, update_term_meta, update_site_meta, update_user_status, update_post_meta

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 );
}