$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.234

Latest news

  • ProcessWire Weekly #511
    In the 511th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new third party module called Auto AVIF, and more. Read on!
    Weekly.pw / 25 February 2024
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 2023
  • 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