1. 首页
  2. WordPress 函数手册

get_user_by()

get_user_by( string $field, int|string $value )

按给定字段检索用户信息
Retrieve user info by a given field

目录锚点:#参数#返回#源码#笔记


参数(Parameters)

参数 类型 必填 说明
$field (string) 必需 用于检索用户的字段。id | id | slug |电子邮件|登录。
$value (int | string) 必需 $field的值。用户ID、slug、电子邮件地址或登录名。

返回(Return)

(WP|u User|false)WP_User object表示成功,false表示失败。


源码(Source)

/**
 * Retrieve user info by a given field
 *
 * @since 2.8.0
 *
 * @param string     $field The field to retrieve the user with. id | slug | email | login
 * @param int|string $value A value for $field. A user ID, slug, email address, or login name.
 * @return WP_User|false WP_User object on success, false on failure.
 */
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;
}
endif;

if ( !function_exists('cache_users') ) :
更新版本 源码位置 使用 被使用
4.4.0 wp-includes/pluggable.php:98 31 2

笔记(Notes)

默认用法
样品响应
我总是喜欢在回显$user对象的任何属性之前检查变量($user)是否为空:

get_user_by() 为WP2原创文章,链接:https://www.wp2.cn/functions/get_user_by/