Master Laravel Events: Quick Reference Cheat Sheet & Code Guide

Laravel Event Quick Reference

Laravel's Event system offers a convenient way to implement event‑driven architecture. The following cheat sheet summarizes the most commonly used commands and facade methods for defining, generating, and handling events.

Key Configuration

Define listeners in EventServiceProvider using the $listen property:

protected $listen = [
    'App\Events\OrderShipped' => [
        'App\Listeners\SendShipmentNotification'
    ],
];

Generate listener classes automatically:

php artisan event:generate

Dispatching Events

// Fire an event (legacy)
Event::fire($event, $payload = [], $halt = false);

// Dispatch an event (current)
Event::dispatch($event, $payload = [], $halt = false);

// Helper function
event($event, $payload = [], $halt = false);

// Dispatch and wait for a response
Event::until($event, $payload = []);

Registering Listeners

// Register a listener for a specific event
Event::listen('App\Events\UserSignup', function ($event) { /* ... */ });

// Wildcard listener
Event::listen('event.*', function ($event) { /* ... */ }); // matches any event prefixed with "event."

// Register a listener with a priority
Event::listen('foo.bar', 'FooHandler', 10);
Event::listen('foo.bar', 'BarHandler', 5);

// Stop propagation by returning false
Event::listen('foor.bar', function ($event) {
    return false;
});

Advanced Management

// Subscribe a class that contains multiple listeners
Event::subscribe('UserEventHandler');

// Retrieve all listeners for an event
Event::getListeners($eventName);

// Remove a specific listener
Event::forget($event);

// Push an event onto the stack for later execution
Event::push($event, $payload = []);

// Remove a specific stacked event
Event::flush($event);

// Clear all stacked events
Event::forgetPushed();

This cheat sheet equips developers with the essential commands and code snippets needed to work efficiently with Laravel's event system.