Retrieves user meta field for a user.

Parameters

$user_idintrequired

User ID.

$keystringoptional

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

Default:''

$singlebooloptional

Whether to return a single value.
This parameter has no effect if $key is not specified.

Default:false

Return

More Information

Please note that if the meta value exists but is empty, it will return an empty string (or array) as if the meta value didn’t exist. This might cause unexpected behaviors in your code when you empty the user meta, your code can try to use add_user_meta instead of update_user_meta thinking the user does not have meta created yet.

Source

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

View all references View on Trac View on GitHub

Changelog