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

Retrieves 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.<br> This parameter has no effect if $key is not specified.<br>

Default value: false


Return

(mixed) An array of values if $single is false.<br> The value of meta data field if $single is true.<br> False for an invalid $user_id (non-numeric, zero, or negative value).<br> An empty string if a valid but non-existing user ID is passed.


Source

File: wp-includes/user.php

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


Changelog

Changelog
Version Description
3.0.0 Introduced.