🔥 Fire events on attribute changes of your Eloquent model

Fund package maintenance!

Installs: 253 061

Dependents: 1

Suggesters: 0

Security: 0

Stars: 299

Watchers: 6

Forks: 20

Open Issues: 1

1.5.0 2023-12-14 14:48 UTC

This package is auto-updated.

Last update: 2024-03-19 15:15:53 UTC


Laravel Attribute Events Laravel Attribute Events

Build Status Last Updated Latest Stable Version License

class Order extends Model
    protected $dispatchesEvents = [
        'status:shipped' => OrderShipped::class,
        'note:*' => OrderNoteChanged::class,

Eloquent models fire several handy events throughout their lifecycle, like created and deleted. However, there are usually many more business meaningful events that happen during a model's life. With this library you can capture those, by mapping attribute changes to your own event classes.


composer require jpkleemans/attribute-events

How to use it

Use the Kleemans\AttributeEvents trait in your model and add the attributes to the $dispatchesEvents property:

class Order extends Model
    use AttributeEvents;

    protected $dispatchesEvents = [
        'created'         => OrderPlaced::class,
        'status:canceled' => OrderCanceled::class,
        'note:*'          => OrderNoteChanged::class,

The attribute events will be dispatched after the updated model is saved. Each event receives the instance of the model through its constructor.

For more info on model events and the $dispatchesEvents property, visit the Laravel Docs


Now you can subscribe to the events via the EventServiceProvider $listen array, or manually with Closure based listeners:

Event::listen(function (OrderCanceled $event) {
    // Restock inventory

Or push realtime updates to your users, using Laravel's broadcasting feature:'orders')
    .listen('OrderShipped', (event) => {
        // Display a notification

JSON attributes

For attributes stored as JSON, you can use the -> operator:

protected $dispatchesEvents = [
    'payment->status:completed' => PaymentCompleted::class,


For more complex state changes, you can use attributes defined by an accessor:

class Product extends Model
    protected $dispatchesEvents = [
        'low_stock:true' => ProductReachedLowStock::class,

    public function getLowStockAttribute(): bool
        return $this->stock <= 3;

You can also use the new way of defining accessors introduced in Laravel 9.

Learn more


Nexxtmove Logo

Thanks to Nexxtmove for sponsoring the development of this project.
Your logo or name here? Sponsor this project.


Code released under the MIT License.