$user->addRole() method

Add Role to this user

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

Example

// Add the "editor" role to the $user
$user->addRole('editor');
$user->save();

Usage

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

Arguments

NameType(s)Description
rolestring, int, Role

May be Role name, object, or ID.

Return value

bool

Returns 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 #555
    In the 555th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module that adds the ability to automatically convert email messages to pages, and more. Read on!
    Weekly.pw / 28 December 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

“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