函数文档

get_user_by_email()

💡 云策文档标注

概述

get_user_by_email() 是一个 WordPress 函数,用于通过电子邮件地址检索用户信息。该函数自 WordPress 3.3.0 版本起已被弃用,建议使用 get_user_by('email') 替代。

关键要点

  • 函数功能:通过电子邮件地址获取用户信息。
  • 参数:$email(字符串,必需),表示用户的电子邮件地址。
  • 返回值:失败时返回 false,成功时返回用户数据库行对象。
  • 弃用状态:自 WordPress 3.3.0 起弃用,应改用 get_user_by('email')。
  • 相关函数:get_user_by() 和 _deprecated_function()。

代码示例

function get_user_by_email($email) {
    _deprecated_function( __FUNCTION__, '3.3.0', "get_user_by('email')" );
    return get_user_by('email', $email);
}

注意事项

使用此函数时,WordPress 会触发弃用警告,建议开发者更新代码以避免未来兼容性问题。


📄 原文内容

Retrieve user info by email.

Description

See also

Parameters

$emailstringrequired
User’s email address

Return

bool|object False on failure, User DB row object

Source

function get_user_by_email($email) {
	_deprecated_function( __FUNCTION__, '3.3.0', "get_user_by('email')" );
	return get_user_by('email', $email);
}

Changelog

Version Description
3.3.0 Deprecated. Use get_user_by()
2.5.0 Introduced.