update_user_meta

Update user meta field based on user ID.

Description

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

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.

Returns (int|bool)

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

Parameters (4)

0. $user_id (int)
The user id.
1. $meta_key (string)
The meta key.
2. $meta_value (mixed)
The meta value.
3. $prev_value — Optional. (string) => ''
Previous value to check before removing.

Usage

  1. if ( !function_exists( 'update_user_meta' ) ) { 
  2.     require_once ABSPATH . WPINC . '/user.php'; 
  3. } 
  4.   
  5. // The user id. 
  6. $user_id = -1; 
  7.   
  8. // The meta key. 
  9. $meta_key = ''; 
  10.   
  11. // The meta value. 
  12. $meta_value = null; 
  13.   
  14. // Optional. Previous value to check before removing. 
  15. $prev_value = ''; 
  16.   
  17. // NOTICE! Understand what this does before running. 
  18. $result = update_user_meta($user_id, $meta_key, $meta_value, $prev_value); 
  19.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/user.php  
  1. function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') { 
  2.     return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value); 
  3. }