get_user_meta( int $user_id, string $key = '', bool $single = false )

Retrieve user meta field for a user.

Parameters

$user_id

(Required) User ID.

$key

(Optional) The meta key to retrieve. By default, returns data for all keys.

Default value: ''

$single

(Optional) Whether to return a single value.

Default value: false

Return

(mixed) Will be an array if $single is false. Will be value of meta data field if $single is true.

Source

File: wp-includes/user.php 

function get_user_meta($user_id, $key = '', $single = false) {
	return get_metadata('user', $user_id, $key, $single);
}

Expand Source Code View on GitHub

Related

Uses

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

Retrieve metadata for the specified object.

Used By

Used By
Used By Description
wp-includes/widgets/class-wp-widget-text.php: WP_Widget_Text::render_control_template_scripts()

Render form template scripts.
wp-includes/class-wp-user.php: WP_User::__get()

Magic method for accessing custom fields.
wp-includes/class-wp-user.php: WP_User::get_caps_data()

Gets the available user capabilities data.
wp-includes/class-wp-user-meta-session-tokens.php: WP_User_Meta_Session_Tokens::get_sessions()

Get all sessions of a user.
wp-includes/user.php: wp_user_personal_data_exporter()

Finds and exports personal data associated with an email address from the user and user_meta table.
wp-includes/user.php: new_user_email_admin_notice()

Adds an admin notice alerting the user to check for confirmation request email after email address change.
wp-includes/user.php: wp_update_user()

Update a user in the database.
wp-includes/user.php: get_blogs_of_user()

Get the sites a user belongs to.
wp-includes/user.php: is_user_member_of_blog()

Find out whether a user is a member of a given blog.
wp-includes/ms-functions.php: wpmu_create_blog()

Create a site.
wp-includes/ms-functions.php: get_active_blog_for_user()

Get one of a user’s active blogs
wp-includes/ms-functions.php: add_user_to_blog()

Adds a user to a blog.
wp-includes/ms-functions.php: remove_user_from_blog()

Remove a user from a blog.
wp-admin/includes/class-wp-screen.php: WP_Screen::render_meta_boxes_preferences()

Render the meta boxes preferences.
wp-admin/includes/ajax-actions.php: wp_ajax_save_user_color_scheme()

Ajax handler for auto-saving the selected color scheme for a user’s own profile.
wp-admin/includes/ajax-actions.php: wp_ajax_dismiss_wp_pointer()

Ajax handler for dismissing a ClassicPress pointer.
wp-admin/includes/class-wp-internal-pointers.php: WP_Internal_Pointers::enqueue_scripts()

Initializes the new feature pointers.
wp-admin/includes/ms.php: choose_primary_blog()

Handles the display of choosing a user’s primary site.
Show 13 more used by Hide more used by

Changelog

Changelog
Version Description
WP-3.0.0 Introduced.