WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_User::remove_role()

WP_User::remove_role( string $role )

In this article

Back to top

Removes role from user.

Parameters

$rolestringrequired
Role name.

Source

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 );
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘remove_user_role’, int $user_id, string $role )

Fires immediately after a role as been removed from a user.

UsesDescription
WP_User::update_user_level_from_caps()wp-includes/class-wp-user.php

Updates the maximum user level for the user.

WP_User::get_role_caps()wp-includes/class-wp-user.php

Retrieves all of the capabilities of the user’s roles, and merges them with individual user capabilities.

update_user_meta()wp-includes/user.php

Updates user meta field based on user ID.

do_action()wp-includes/plugin.php

Calls the callback functions that have been added to an action hook.

Show 1 moreShow less

Changelog

VersionDescription
2.0.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Andy Schmidt
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    The $role parameter is validated against currently active roles for this blog. That means this method cannot be used to “clean-up” obsolete role assignments for roles that had once existed but do no more.

    If used as part of the a plug-in uninstall, be certain to first un-assign roles from users before removing the role definition from the blog:

    $user = new \WP_User( null, 'some user login' );
	if ( $user->exists() )
		// First un-assign still-existing custom role from user.
		$user->remove_role( 'custom_role' );
	
	// Then remove custom role from blog.
	\remove_role( 'custom_role' );

You must log in before being able to contribute a note or feedback.