User Group Repository

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

use Statamic\Facades\UserGroup;

Methods

Querying

Examples

Get a User Group

UserGroup::find('admin');

Get all users in a group

UserGroup::find('editors')
    ->queryUsers()
    ->get();

Find admins with an avatar

UserGroup::find('admin')
    ->queryUsers()
    ->where('avatar', true)
    ->get();

Creating

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

$group = UserGroup::make('admin');

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

$group
    ->title('Administrators')
    ->roles($roles); // array of role handles

Finally, save it.

$group->save();