Skip to main content
Shopper uses spatie/laravel-permission to manage roles and permissions. Every admin user has one or more roles, and each role has a set of permissions that control access to admin panel sections and actions. Since all permissions are registered on Laravel’s gate, you can use Laravel’s built-in can() function and @can Blade directive. For a visual walkthrough of managing roles and permissions in the admin panel, see the User Guide pages: Managing Staff and Roles & Permissions.

​
Configuration

Roles are configured in config/shopper/admin.php. These names are used throughout the system for authorization checks: 
'roles' => [
    'admin' => 'administrator',
    'manager' => 'manager',
    'user' => 'user',
],
RolePurposeAdmin Access
administratorFull access to all admin panel featuresYes
managerConfigurable access based on assigned permissionsYes
userCustomer role, assigned to storefront usersNo
Do not rename roles after they have been assigned to users. Role names are used in middleware and authorization checks throughout the system.

​
Models

​
Role

The model used is Shopper\Models\Role, which extends Spatie’s Role model with additional fields.
ColumnTypeNullableDefaultDescription
idbigintnoautoPrimary key
namestringno-Role name in lowercase (e.g., administrator)
guard_namestringnoautoFilled automatically by Spatie
display_namestringyesnullHuman-readable name
descriptiontextyesnullRole description
can_be_removedbooleannotrueWhether the role can be deleted
The Role model provides an isAdmin() method: 
use Shopper\Models\Role;

$role = Role::query()->where('name', 'administrator')->first();
$role->isAdmin(); // true

​
Permission

The model used is Shopper\Models\Permission, which extends Spatie’s Permission model with grouping support.
ColumnTypeNullableDefaultDescription
idbigintnoautoPrimary key
namestringno-Permission name (e.g., browse_products)
guard_namestringnoautoFilled automatically by Spatie
group_namestringyesnullPermission group for organization
display_namestringyesnullHuman-readable name
descriptiontextyesnullPermission description
can_be_removedbooleannotrueWhether the permission can be deleted

​
Permission Groups

Permissions are organized into groups for display in the admin panel: 
use Shopper\Models\Permission;

Permission::groups();
This returns the built-in groups: system, brands, categories, collections, products, customers, orders, discounts.

​
Generating Permissions

The Permission::generate() method creates five permissions for a given resource (browse, read, edit, add, delete): 
Permission::generate('brands');
// Creates: browse_brands, read_brands, add_brands, edit_brands, delete_brands

Permission::generate('tags', 'products');
// Creates: browse_tags, read_tags, add_tags, edit_tags, delete_tags (in the "products" group)

​
Working with Roles

​
Creating Roles

To create a new role programmatically: 
use Shopper\Models\Role;

$role = Role::query()->create([
    'name' => 'warehouse-manager',
    'display_name' => 'Warehouse Manager',
    'description' => 'Manages inventory locations and stock levels.',
]);

$role->givePermissionTo([
    'browse_inventories',
    'read_inventories',
    'edit_inventories',
    'browse_products',
    'read_products',
]);

​
Assigning Roles

Assign a role to a user: 
$user->assignRole('warehouse-manager');

$user->assignRole(config('shopper.admin.roles.admin'));

​
Checking Roles

The InteractsWithShopper trait on the User model provides role checking methods: 
$user->isAdmin();    // true if user has the administrator role
$user->isManager();  // true if user has the manager role

$user->hasRole('warehouse-manager');

​
Working with Permissions

​
Checking Permissions

Use Laravel’s standard authorization: 
$user->hasPermissionTo('browse_products');

$user->can('edit_products');
In Blade templates: 
@can('add_products')
    <a href="/admin/products/create">Add Product</a>
@endcan
In Livewire components, Shopper uses the authorize() method: 
public function mount(): void
{
    $this->authorize('browse_products');
}

​
Creating Custom Permissions

To add a custom permission and assign it to a role: 
use Shopper\Models\Permission;
use Shopper\Models\Role;

$permission = Permission::query()->create([
    'name' => 'view_analytics',
    'group_name' => 'system',
    'display_name' => 'View Analytics',
    'description' => 'Access the analytics dashboard.',
]);

$role = Role::query()->where('name', 'manager')->first();
$role->givePermissionTo($permission);
Custom permissions without a recognized group appear in a “Custom permissions” section in the admin panel.

​
Revoking Permissions

To remove a permission from a role: 
$role->revokePermissionTo('delete_products');

​
Admin User Creation

You can create an admin user from the command line: 
php artisan shopper:user
Or programmatically: 
use App\Models\User;
use Illuminate\Support\Facades\Hash;

$admin = User::query()->create([
    'first_name' => 'John',
    'last_name' => 'Doe',
    'email' => 'admin@example.com',
    'password' => Hash::make('password'),
    'email_verified_at' => now(),
]);

$admin->assignRole(config('shopper.admin.roles.admin'));

​
Components

To customize the roles and permissions admin UI: 
php artisan shopper:component:publish setting
The relevant components in config/shopper/components/setting.php: 
use Shopper\Livewire;

return [
    'pages' => [
        'team-index' => Livewire\Pages\Settings\Team\Index::class,
        'team-roles' => Livewire\Pages\Settings\Team\RolePermission::class,
    ],
    'components' => [
        'settings.team.permissions' => Livewire\Components\Settings\Team\Permissions::class,
        'settings.team.users' => Livewire\Components\Settings\Team\UsersRole::class,
        'slide-overs.create-team-member' => Livewire\SlideOvers\CreateTeamMember::class,
    ],
];