$user→addRole()

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.252