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

Adds meta data to a user.

Parameters

$user_id

(int) (Required) User ID.

$meta_key

(string) (Required) Metadata name.

$meta_value

(mixed) (Required) Metadata value. Must be serializable if non-scalar.

$unique

(bool) (Optional) Whether the same key should not be added.

Default value: false

Return

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

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 );
}

Uses

Uses Description
wp-includes/meta.php: add_metadata()

Adds metadata for the specified object.

Changelog

Version Description
3.0.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_user_meta