Adds role to user.
Description
Updates the user’s meta data option with capabilities and roles.
Parameters
$rolestringrequired- Role name.
Source
public function add_role( $role ) {
if ( empty( $role ) ) {
return;
}
if ( in_array( $role, $this->roles, true ) ) {
return;
}
$this->caps[ $role ] = true;
update_user_meta( $this->ID, $this->cap_key, $this->caps );
$this->get_role_caps();
$this->update_user_level_from_caps();
/**
* Fires immediately after the user has been given a new role.
*
* @since 4.3.0
*
* @param int $user_id The user ID.
* @param string $role The new role.
*/
do_action( 'add_user_role', $this->ID, $role );
}
Hooks
- do_action( ‘add_user_role’,
int $user_id ,string $role ) Fires immediately after the user has been given a new role.
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |
Despite that add_role() is a method of the WP_User object, the action is persistent. That is, the user’s database record is updated to include the added role.