钩子文档

set_user_role

💡 云策文档标注

概述

set_user_role 是一个 WordPress 动作钩子,在用户角色更改后触发,允许开发者执行自定义操作。

关键要点

  • 触发时机:用户角色更改后立即执行。
  • 参数:$user_id(用户ID)、$role(新角色)、$old_roles(旧角色数组)。
  • 用途:常用于扩展用户角色管理功能,如发送通知或更新相关数据。

代码示例

do_action( 'set_user_role', $this->ID, $role, $old_roles );

注意事项

  • 从 WordPress 3.6.0 版本开始,添加了 $old_roles 参数以提供旧角色数组。
  • 此钩子最初在 WordPress 2.9.0 版本中引入。

📄 原文内容

Fires after the user’s role has changed.

Parameters

$user_idint
The user ID.
$rolestring
The new role.
$old_rolesstring[]
An array of the user’s previous roles.

Source

do_action( 'set_user_role', $this->ID, $role, $old_roles );

Changelog

Version Description
3.6.0 Added $old_roles to include an array of the user’s previous roles.
2.9.0 Introduced.