get_user_meta()

最后更新于:2021-11-27 03:57:26

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

Retrieve user meta field for a user.

参数

$user_id

(int) (Required) User ID.

$key

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

Default value: ”

$single

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

Default value: false

响应

(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 string if a valid but non-existing user ID is passed.

源文件

文件: gc-includes/user.php

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