函数原型
get_user_by( string $field, int|string $value ): WP_User|false
函数描述
Retrieves user info by a given field.
是否弃用
未弃用
函数参数
-
$field
string
Required - The field to retrieve the user with. id | ID | slug | email | login.
-
$value
int|string
Required - A value for $field. A user ID, slug, email address, or login name.
函数返回值
WP_User|false WP_User object on success, false on failure.
函数位置
File: wp-includes/pluggable.php.
函数源码
function get_user_by( $field, $value ) {
$userdata = WP_User::get_data_by( $field, $value );
if ( ! $userdata ) {
return false;
}
$user = new WP_User;
$user->init( $userdata );
return $user;
}
源码链接
变更日志
| Version | Description |
|---|---|
| 4.4.0 | Added 'ID' as an alias of 'id' for the $field parameter. |
| 2.8.0 | Introduced. |

