WP_User::remove_role() WordPress Method
The WP_User::remove_role() function can be used to remove a role from a user. This function takes two parameters: the user ID and the role name.
WP_User::remove_role( string $role ) #
Removes role from user.
Parameters
- $role
(string)(Required)Role name.
Source
File: wp-includes/class-wp-user.php
public function remove_role( $role ) { if ( ! in_array( $role, $this->roles, true ) ) { return; } unset( $this->caps[ $role ] ); update_user_meta( $this->ID, $this->cap_key, $this->caps ); $this->get_role_caps(); $this->update_user_level_from_caps(); /** * Fires immediately after a role as been removed from a user. * * @since 4.3.0 * * @param int $user_id The user ID. * @param string $role The removed role. */ do_action( 'remove_user_role', $this->ID, $role ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |