函数原型
get_user_meta( int $user_id, string $key = ”, bool $single = false ): mixed
函数描述
Retrieves 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:
'' -
$single
bool
Optional - Whether to return a single value.
This parameter has no effect if$keyis not specified.
Default:
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.
函数位置
File: wp-includes/user.php.
函数源码
function get_user_meta( $user_id, $key = '', $single = false ) {
return get_metadata( 'user', $user_id, $key, $single );
}
源码链接
变更日志
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
