$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 #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer