Extending | laravel-permission | Spatie SPATIE Laravel Permission ===================== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-permission](https://spatie.be/docs/laravel-permission/v5) Advanced-usage Extending Version v7 v6 v5 v4 v3 Other versions for crawler [v7](https://spatie.be/docs/laravel-permission/v7) [v6](https://spatie.be/docs/laravel-permission/v6) [v5](https://spatie.be/docs/laravel-permission/v5) [v4](https://spatie.be/docs/laravel-permission/v4) [v3](https://spatie.be/docs/laravel-permission/v3) - [ Introduction ](https://spatie.be/docs/laravel-permission/v5/introduction) - [ Support us ](https://spatie.be/docs/laravel-permission/v5/support-us) - [ Prerequisites ](https://spatie.be/docs/laravel-permission/v5/prerequisites) - [ Installation in Laravel ](https://spatie.be/docs/laravel-permission/v5/installation-laravel) - [ Installation in Lumen ](https://spatie.be/docs/laravel-permission/v5/installation-lumen) - [ Upgrading ](https://spatie.be/docs/laravel-permission/v5/upgrading) - [ Questions and issues ](https://spatie.be/docs/laravel-permission/v5/questions-issues) - [ Changelog ](https://spatie.be/docs/laravel-permission/v5/changelog) - [ About us ](https://spatie.be/docs/laravel-permission/v5/about-us) Basic Usage ----------- - [ Basic Usage ](https://spatie.be/docs/laravel-permission/v5/basic-usage/basic-usage) - [ Direct Permissions ](https://spatie.be/docs/laravel-permission/v5/basic-usage/direct-permissions) - [ Using Permissions via Roles ](https://spatie.be/docs/laravel-permission/v5/basic-usage/role-permissions) - [ Enums ](https://spatie.be/docs/laravel-permission/v5/basic-usage/enums) - [ Teams permissions ](https://spatie.be/docs/laravel-permission/v5/basic-usage/teams-permissions) - [ Wildcard permissions ](https://spatie.be/docs/laravel-permission/v5/basic-usage/wildcard-permissions) - [ Blade directives ](https://spatie.be/docs/laravel-permission/v5/basic-usage/blade-directives) - [ Using a middleware ](https://spatie.be/docs/laravel-permission/v5/basic-usage/middleware) - [ Defining a Super-Admin ](https://spatie.be/docs/laravel-permission/v5/basic-usage/super-admin) - [ Using multiple guards ](https://spatie.be/docs/laravel-permission/v5/basic-usage/multiple-guards) - [ Using artisan commands ](https://spatie.be/docs/laravel-permission/v5/basic-usage/artisan) - [ Example App ](https://spatie.be/docs/laravel-permission/v5/basic-usage/new-app) Best Practices -------------- - [ Roles vs Permissions ](https://spatie.be/docs/laravel-permission/v5/best-practices/roles-vs-permissions) - [ Model Policies ](https://spatie.be/docs/laravel-permission/v5/best-practices/using-policies) - [ Performance Tips ](https://spatie.be/docs/laravel-permission/v5/best-practices/performance) Advanced usage -------------- - [ Testing ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/testing) - [ Database Seeding ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/seeding) - [ Exceptions ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/exceptions) - [ Extending ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/extending) - [ Cache ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/cache) - [ Custom Permission Check ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/custom-permission-check) - [ UUID ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/uuid) - [ PhpStorm Interaction ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/phpstorm) - [ Other ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/other) - [ Timestamps ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/timestamps) - [ UI Options ](https://spatie.be/docs/laravel-permission/v5/advanced-usage/ui-options) You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command: ` composer show spatie/laravel-permission ` Extending ========= ### On this page 1. [ Adding fields to your models ](#content-adding-fields-to-your-models) 2. [ Adding a description to roles and permissions ](#content-adding-a-description-to-roles-and-permissions) 3. [ Extending User Models ](#content-extending-user-models) 4. [ Child User Models ](#content-child-user-models) 5. [ Extending Role and Permission Models ](#content-extending-role-and-permission-models) Adding fields to your models -------------------------------------------------------------------------------------------------------------------------------------------- You can add your own migrations to make changes to the role/permission tables, as you would for adding/changing fields in any other tables in your Laravel project. Following that, you can add any necessary logic for interacting with those fields into your custom/extended Models. Here is an example of adding a 'description' field to your Permissions and Roles tables: ``` php artisan make:migration add_description_to_permissions_tables ``` And in the migration file: ``` public function up() { Schema::table('permissions', function (Blueprint $table) { $table->string('description')->nullable(); }); Schema::table('roles', function (Blueprint $table) { $table->string('description')->nullable(); }); } ``` Semi-Related article: [Adding Extra Fields To Pivot Table](https://quickadminpanel.com/blog/laravel-belongstomany-add-extra-fields-to-pivot-table/) (video) Adding a description to roles and permissions ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- A common question is "how do I add a description for my roles or permissions?". By default, a 'description' field is not included in this package, to keep the model memory usage low, because not every app has a need for displayed descriptions. But you are free to add it yourself if you wish. You can use the example above. ### Multiple Language Descriptions If you need your 'description' to support multiple languages, simply use Laravel's built-in language features. You might prefer to rename the 'description' field in these migration examples from 'description' to 'description\_key' for clarity. Extending User Models ----------------------------------------------------------------------------------------------------------------------- Laravel's authorization features are available in models which implement the `Illuminate\Foundation\Auth\Access\Authorizable` trait. By default Laravel does this in `\App\Models\User` by extending `Illuminate\Foundation\Auth\User`, in which the trait and `Illuminate\Contracts\Auth\Access\Authorizable` contract are declared. If you are creating your own User models and wish Authorization features to be available, you need to implement `Illuminate\Contracts\Auth\Access\Authorizable` in one of those ways as well. Child User Models ----------------------------------------------------------------------------------------------------------- Due to the nature of polymorphism and Eloquent's hard-coded mapping of model names in the database, setting relationships for child models that inherit permissions of the parent can be difficult (even near impossible depending on app requirements, especially when attempting to do inverse mappings). However, one thing you might consider if you need the child model to never have its own permissions/roles but to only use its parent's permissions/roles, is to [override the `getMorphClass` method on the model](https://github.com/laravel/framework/issues/17830#issuecomment-345619085). eg: This could be useful, but only if you're willing to give up the child's independence for roles/permissions: ``` public function getMorphClass() { return 'users'; } ``` Extending Role and Permission Models -------------------------------------------------------------------------------------------------------------------------------------------------------------------- If you are extending or replacing the role/permission models, you will need to specify your new models in this package's `config/permission.php` file. First be sure that you've published the configuration file (see the Installation instructions), and edit it to update the `models.role` and `models.permission` values to point to your new models. Note the following requirements when extending/replacing the models: ### Extending If you need to EXTEND the existing `Role` or `Permission` models note that: - Your `Role` model needs to `extend` the `Spatie\Permission\Models\Role` model - Your `Permission` model needs to `extend` the `Spatie\Permission\Models\Permission` model - You need to update `config/permission.php` to specify your namespaced model eg: ```