函数文档

get_user_to_edit()

💡 云策文档标注

概述

get_user_to_edit() 函数用于检索用户数据并应用 'edit' 过滤器,以便在编辑上下文中安全使用。它基于 get_userdata() 获取用户信息,并返回 WP_User 对象或 false。

关键要点

  • 参数:$user_id(整数,必需),指定用户 ID。
  • 返回值:成功时返回 WP_User 对象,失败时返回 false。
  • 功能:通过设置 $user->filter = 'edit' 来过滤用户数据,确保数据适合编辑操作。
  • 依赖:内部调用 get_userdata() 函数来获取用户信息。
  • 版本:自 WordPress 2.0.5 版本引入。

代码示例

function get_user_to_edit( $user_id ) {
	$user = get_userdata( $user_id );

	if ( $user ) {
		$user->filter = 'edit';
	}

	return $user;
}

📄 原文内容

Retrieve user data and filter it.

Parameters

$user_idintrequired
User ID.

Return

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

Source

function get_user_to_edit( $user_id ) {
	$user = get_userdata( $user_id );

	if ( $user ) {
		$user->filter = 'edit';
	}

	return $user;
}

Changelog

Version Description
2.0.5 Introduced.