add_user_meta( int $user_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false
Adds meta data to a user.
Parameters
-
$user_idint Required -
User ID.
-
$meta_keystring Required -
Metadata name.
-
$meta_valuemixed Required -
Metadata value. Must be serializable if non-scalar.
-
$uniquebool Optional -
Whether the same key should not be added.
Default:
false
Return
int|false Meta ID on success, false on failure.
Source
File: wp-includes/user.php.
View all references
function add_user_meta( $user_id, $meta_key, $meta_value, $unique = false ) {
return add_metadata( 'user', $user_id, $meta_key, $meta_value, $unique );
}
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Examples