User Role Repository

To work with the with Role Repository, use the following Facade:

use Statamic\Facades\Role;

Methods

Methods Description
all() Get all User Roles
find($id) Get User Roles by id
make() Makes a new Role instance
Hot Tip!

The id is the same as handle while using the default Stache driver.

Creating

Start by making an instance of a user role with the make method. You can pass the handle into it.

$role = Role::make('editors');

You may call additional methods on the role to customize it further.

$role
->title('Editors')
->permissions($permissions); // array of permissions

Finally, save it.

$role->save();
HR: Section
Learn More!

Learn more about User Role Repository in these related docs:

Fieldtypes

HR: Section
Docs feedback

Submit improvements, related content, or suggestions through Github.

Betterify this page →