add_user_meta() – Function | Developer.WordPress.org

Adds meta data to a user.

Parameters

$user_idintrequired

User ID.

$meta_keystringrequired

Metadata name.

$meta_valuemixedrequired

Metadata value. Arrays and objects are stored as serialized data and will be returned as the same type when retrieved. Other data types will be stored as strings in the database:

false is stored and retrieved as an empty string ('')
true is stored and retrieved as '1'
numbers (both integer and float) are stored and retrieved as strings Must be serializable if non-scalar.

$uniquebooloptional

Whether the same key should not be added.

Default:false

Return

int|false Meta ID on success, false on failure.

Source

function add_user_meta( $user_id, $meta_key, $meta_value, $unique = false ) {
	return add_metadata( 'user', $user_id, $meta_key, $meta_value, $unique );
}

View all references View on Trac View on GitHub

Uses	Description
add_metadata()`wp-includes/meta.php`	Adds metadata for the specified object.

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.
wp_insert_user()`wp-includes/user.php`	Inserts a user into the database.

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
Examples
```
<?php
$user_id = 1;
$awesome_level = 1000;
add_user_meta( $user_id, '_level_of_awesomeness', $awesome_level);
?>
```
Log in to add feedback

add_user_meta( int $user_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false

In this article

Parameters

Return

Source

Changelog

User Contributed Notes

add_user_meta( int $user_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false

In this article

Parameters

Return

Source

Related

Changelog

User Contributed Notes