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

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer