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

Add meta data field to a user.

Description Description

Post meta data is called "Custom Fields" on the Administration Screens.

Parameters Parameters


(int) (Required) User ID.


(string) (Required) Metadata name.


(mixed) (Required) Metadata value.


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

Default value: false

Top ↑

Return Return

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

Top ↑

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

Top ↑

Changelog Changelog

Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.