add_user_meta

Add meta data field to a user.

Description

(int|false) add_user_meta( (int) $user_id, (string) $meta_key, (mixed) $meta_value, (constant) $unique = false ); 

Post meta data is called Custom Fields on the Administration Screens.

Returns (int|false)

Meta ID on success, false on failure.

Parameters (4)

0. $user_id (int)
The user id.
1. $meta_key (string)
Metadata name.
2. $meta_value (mixed)
The meta value.
3. $unique — Optional. (constant) => false
Optional, default is false. Whether the same key should not be added.

Usage

  1. if ( !function_exists( 'add_user_meta' ) ) { 
  2.     require_once ABSPATH . WPINC . '/user.php'; 
  3. } 
  4.   
  5. // The user id. 
  6. $user_id = -1; 
  7.   
  8. // Metadata name. 
  9. $meta_key = ''; 
  10.   
  11. // The meta value. 
  12. $meta_value = null; 
  13.   
  14. // Optional, default is false. Whether the same key should not be added. 
  15. $unique = false; 
  16.   
  17. // NOTICE! Understand what this does before running. 
  18. $result = add_user_meta($user_id, $meta_key, $meta_value, $unique); 
  19.     

Defined (1)

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

/wp-includes/user.php  
  1. function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) { 
  2.     return add_metadata('user', $user_id, $meta_key, $meta_value, $unique); 
  3. }