函数文档

get_user()

💡 云策文档标注

概述

get_user() 函数通过用户 ID 检索用户信息,返回 WP_User 对象或 false。它是 get_user_by() 的封装,专门用于基于 ID 的查询。

关键要点

  • 参数:$user_id(整数,必需),指定要检索的用户 ID。
  • 返回值:成功时返回 WP_User 对象,失败时返回 false。
  • 内部实现:调用 get_user_by('id', $user_id) 来执行实际检索。
  • 引入版本:WordPress 6.7.0 中首次引入。

代码示例

function get_user( $user_id ) {
	return get_user_by( 'id', $user_id );
}

注意事项

此函数是 get_user_by() 的便捷封装,适用于基于用户 ID 的快速检索场景。确保传入有效的用户 ID 以避免返回 false。


📄 原文内容

Retrieves user info by user ID.

Parameters

$user_idintrequired
User ID.

Return

WP_User|false WP_User object on success, false on failure.

Source

function get_user( $user_id ) {
	return get_user_by( 'id', $user_id );
}

Changelog

Version Description
6.7.0 Introduced.