add_user_meta( int $user_id, string $meta_key, mixed $meta_value, bool $unique = false )
Add meta data field to a user.
Description Description
Post meta data is called "Custom Fields" on the Administration Screens.
Parameters Parameters
- $user_id
-
(int) (Required) User ID.
- $meta_key
-
(string) (Required) Metadata name.
- $meta_value
-
(mixed) (Required) Metadata value.
- $unique
-
(bool) (Optional) Whether the same key should not be added.
Default value: false
Return Return
(int|false) Meta ID on success, false on failure.
Source Source
File: wp-includes/user.php
function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Examples