wpseek.com
A WordPress-centric search engine for devs and theme authors



get_user_meta › WordPress Function

Since3.0.0
Deprecatedn/a
› get_user_meta ( $user_id, $key = '', $single = false )
Parameters: (3)
  • (int) $user_id User ID.
    Required: Yes
  • (string) $key Optional. The meta key to retrieve. By default, returns data for all keys.
    Required: No
    Default: (empty)
  • (bool) $single Optional. Whether to return a single value. This parameter has no effect if `$key` is not specified. Default false.
    Required: No
    Default: false
Links:
Returns:
  • (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.
Defined at:
Codex:

Retrieves user meta field for a user.



Related Functions: get_usermeta, get_site_meta, get_term_meta, get_user_details, delete_user_meta

Source 

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