Core Function

get_user_meta()

get_user_meta( mixed $user_id, mixed $key = '', mixed $single = false )

Retrieves user meta field for a user.

Parameters 3 required

Name / Type	Description
$user_id int	User ID. Required
string	$key Optional. The meta key to retrieve. By default, returns data for all keys. Required
bool	$single Optional. Whether to return a single value. This parameter has no effect if `$key` is not specified. Default false. Required

Return Value

(mixed)

mixed An array of values if `$single` is false. The value of meta data field if `$single` is true. False for an invalid `$user_id` (non-numeric, zero, or negative value). An empty array if a valid but non-existing user ID is passed and `$single` is false. An empty string if a valid but non-existing user ID is passed and `$single` is true. Note: Non-serialized values are returned as strings: - false values are returned as empty strings ('') - true values are returned as '1' - numbers (both integer and float) are returned as strings Arrays and objects retain their original type.

Function Information

Since Version

3.0.0

Source File

wp-includes/user.php