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

Parameters

$user_idint

User ID.

$meta_keystring

Metadata name.

$meta_valuemixed

Metadata value. Must be serializable if non-scalar.

$uniquebooloptional

Whether the same key should not be added. Default false.Default: false

Return

int|false

Meta ID on success, false on failure.

Uses · 1

• add_metadata()Adds metadata for the specified object.

Used by · 2

• WP_Internal_Pointers::dismiss_pointers_for_new_users()Prevents new users from seeing existing 'new feature' pointers.
• wp_insert_user()Inserts a user into the database.

Source

View on Trac ↗View on GitHub ↗

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

History

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/user.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.