函数文档

get_userdatabylogin()

💡 云策文档标注

概述

get_userdatabylogin() 是一个 WordPress 函数,用于通过登录名检索用户信息。该函数自 3.3.0 版本起已被弃用,建议使用 get_user_by() 替代。

关键要点

  • 函数功能:通过用户登录名获取用户数据。
  • 参数:$user_login(字符串,必需),表示用户的用户名。
  • 返回值:失败时返回 false,成功时返回用户数据库行对象。
  • 弃用状态:自 WordPress 3.3.0 版本起被弃用,应改用 get_user_by('login', $user_login)。
  • 相关函数:get_user_by() 用于按指定字段检索用户信息,_deprecated_function() 用于标记弃用函数。

代码示例

function get_userdatabylogin($user_login) {
    _deprecated_function( __FUNCTION__, '3.3.0', "get_user_by('login')" );
    return get_user_by('login', $user_login);
}

注意事项

  • 此函数已弃用,新代码中应避免使用,以保持兼容性和最佳实践。
  • 使用 get_user_by('login', $user_login) 作为替代,功能相同但更现代。

📄 原文内容

Retrieve user info by login name.

Description

See also

Parameters

$user_loginstringrequired
User’s username

Return

bool|object False on failure, User DB row object

Source

function get_userdatabylogin($user_login) {
	_deprecated_function( __FUNCTION__, '3.3.0', "get_user_by('login')" );
	return get_user_by('login', $user_login);
}

Changelog

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