$user->removeRole() method

Remove Role from this user

This is the same as $user->roles->remove($role) except this one will accept ID or name.

Example

// Remove the "editor" role from the $user
$user->removeRole('editor');
$user->save();

Usage

$bool = $user->removeRole($role);

Arguments

NameType(s)Description
rolestring, int, Role

May be Role name, object or ID.

Return value

bool

false if role not recognized, true otherwise


$user methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK