On this page
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 );
}
Related
Uses
| Uses | Description |
|---|---|
| add_metadata() wp-includes/meta.php | Adds metadata for the specified object. |
Used By
| Used By | Description |
|---|---|
| WP_Internal_Pointers::dismiss_pointers_for_new_users() wp-admin/includes/class-wp-internal-pointers.php | Prevents new users from seeing existing ‘new feature’ pointers. |
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_user_meta