函数文档

get_user_details()

💡 云策文档标注

概述

get_user_details() 是一个已弃用的 WordPress 函数,用于通过用户名检索用户信息。自 WordPress 3.0.0 起,建议使用 get_user_by() 替代。

关键要点

  • 函数 get_user_details() 已弃用,自 WordPress 3.0.0 起不应再使用。
  • 替代函数为 get_user_by(),它通过指定字段(如 'login')检索用户信息。
  • 函数内部调用 _deprecated_function() 来标记弃用状态并通知开发者。
  • 参数 $username 是必需的字符串类型,表示用户名。

代码示例

function get_user_details( $username ) {
    _deprecated_function( __FUNCTION__, '3.0.0', 'get_user_by()' );
    return get_user_by('login', $username);
}

注意事项

在开发中应避免使用此弃用函数,以保持代码兼容性和遵循 WordPress 最佳实践。


📄 原文内容

Deprecated functionality to retrieve user information.

Description

See also

Parameters

$usernamestringrequired
Username.

Source

function get_user_details( $username ) {
	_deprecated_function( __FUNCTION__, '3.0.0', 'get_user_by()' );
	return get_user_by('login', $username);
}

Changelog

Version Description
3.0.0 Deprecated. Use get_user_by()
MU (3.0.0) Introduced.