This is the documentation for v5 but the latest version is v6 . You can switch versions in the menu at the top. Check your current version with the following command:

composer show spatie/laravel-permission

Upgrading

On this page

  1. Upgrade Essentials
  2. Upgrading from v4 to v5
  3. Upgrading from v3 to v4
  4. Upgrading from v2 to v3
  5. Upgrading from v1 to v2

ALL upgrades of this package should follow these steps:

  1. Composer. Upgrading between major versions of this package always require the usual Composer steps:

    • Update your composer.json to specify the new major version, such as ^6.0
    • Then run composer update.

  2. Migrations. Compare the migration file stubs in the NEW version of this package against the migrations you've already run inside your app. If necessary, create a new migration (by hand) to apply any new database changes.

  3. Config file. Incorporate any changes to the permission.php config file, updating your existing file. (It may be easiest to make a backup copy of your existing file, re-publish it from this package, and then re-make your customizations to it.)

  4. Models. If you have made any custom Models by extending them into your own app, compare the package's old and new models and apply any relevant updates to your custom models.

  5. Custom Methods/Traits. If you have overridden any methods from this package's Traits, compare the old and new traits, and apply any relevant updates to your overridden methods.

  6. Contract/Interface updates. If you have implemented this package's contracts in any models, check to see if there were any changes to method signatures. Mismatches will trigger PHP errors.

  7. Apply any version-specific special updates as outlined below...

  8. Review the changelog, which details all the changes: CHANGELOG and/or consult the Release Notes

Follow the instructions described in "Essentials" above.

Update composer.json as described in "Essentials" above.

Update composer.json as described in "Essentials" above.

There were significant database and code changes between v1 to v2.

If you're upgrading from v1 to v2, there's no built-in automatic migration/conversion of your data to the new structure. You will need to carefully adapt your code and your data manually.

Tip: @fabricecw prepared a gist which may make your data migration easier.

You will also need to remove your old laravel-permission.php config file and publish the new one permission.php, and edit accordingly (setting up your custom settings again in the new file, where relevant).