Skip to content
⏱️Make Laravel model versionable
Branch: master
Clone or download

Latest commit

Latest commit 7669e9a Apr 20, 2020


Type Name Latest commit message Commit time
Failed to load latest commit information.
.github github actions. Apr 20, 2020
config Add version creator relation. Nov 12, 2019
migrations CS & Readme. May 31, 2019
src Merge branch 'master' of Apr 9, 2020
tests Add withoutVersion method. Mar 19, 2020
.editorconfig wip May 31, 2019
.gitattributes wip May 31, 2019
.gitignore wip May 31, 2019
.php_cs wip May 31, 2019
.travis.yml Remove PHP 7.1 Jun 3, 2019 Create Jun 2, 2019
LICENSE Create LICENSE Jun 2, 2019 Add withoutVersion method. Mar 19, 2020
composer.json Add support for laravel 7.1 and PHPUnit 9 Mar 12, 2020
phpunit.xml.dist wip May 31, 2019


⏱️ Make Laravel model versionable.

Build Status Latest Stable Version Latest Unstable Version Scrutinizer Code Quality Code Coverage Total Downloads License

It's a minimalist way to make your model support version history, and it's very simple to roll back to the specified version.


  • Keep the specified number of versions.
  • Whitelist and blacklist for versionable attributes.
  • Easily roll back to the specified version.
  • Record only changed attributes.
  • Easy to customize.


$ composer require overtrue/laravel-versionable -vvv

Optional, you can publish the config file:

$ php artisan vendor:publish --provider="Overtrue\\LaravelVersionable\\ServiceProvider" --tag=config

And if you want to custom the migration of the versions table, you can publish the migration file to your database path:

$ php artisan vendor:publish --provider="Overtrue\\LaravelVersionable\\ServiceProvider" --tag=migrations

Then run this command to create a database migration:

$ php artisan migrate


Add Overtrue\LaravelVersionable\Versionable trait to the model and set versionable attributes:

use Overtrue\LaravelVersionable\Versionable;

class Post extends Model
    use Versionable;
     * Versionable attributes
     * @var array
    protected $versionable = ['title', 'content'];

Versions will be created on vensionable model saved.

$post = Post::create(['title' => 'version1', 'content' => 'version1 content']);
$post->update(['title' => 'version2']);

Get versions

Get all versions


Get last version



Reversion a model instance to the specified version:


// or


Remove All versions


Temporarily disable versioning

// create
Post::withoutVersion(function () use (&$post) {
    Post::create(['title' => 'version1', 'content' => 'version1 content']);

// update
Post::withoutVersion(function () use ($post) {
    $post->update(['title' => 'updated']);

Custom Version Store strategy

You can set the following different version policies through property protected $versionStrategy:

  • Overtrue\LaravelVersionable::DIFF - Version content will only contain changed attributes (Default Strategy).
  • Overtrue\LaravelVersionable::SNAPSHOT - Version content will contain all versionable attributes values.


You can contribute in one of three ways:

  1. File bug reports using the issue tracker.
  2. Answer questions or fix bugs on the issue tracker.
  3. Contribute new features or update the wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.



You can’t perform that action at this time.