Creating listeners in Laravel - Visual Walkthrough

Concept Flow - Creating listeners

Define Event Class

↓

Define Listener Class

↓

Register Listener in EventServiceProvider

↓

Trigger Event in Code

↓

Listener Handles Event

↓

Perform Action (e.g., send email)

This flow shows how you create an event listener: define event and listener classes, register the listener, then trigger the event to run the listener's action.

Execution Sample

Laravel

class UserRegistered {
  public $user;
  public function __construct($user) { $this->user = $user; }
}

class SendWelcomeEmail {
  public function handle(UserRegistered $event) {
    // send email to $event->user
  }
}

Defines an event carrying a user and a listener that sends a welcome email when the event is triggered.

Execution Table

Step	Action	Code Location	State Before	State After	Effect
1	Define UserRegistered event class	app/Events/UserRegistered.php	No event class	UserRegistered class exists	Event class ready to carry user data
2	Define SendWelcomeEmail listener class	app/Listeners/SendWelcomeEmail.php	No listener class	SendWelcomeEmail class exists	Listener ready to handle event
3	Register listener in EventServiceProvider	app/Providers/EventServiceProvider.php	Listeners array empty or missing entry	Listeners array includes UserRegistered => SendWelcomeEmail	Laravel knows to call listener on event
4	Trigger event with new user	Controller or service code	No event triggered	UserRegistered event dispatched with user data	Event system starts listener
5	Listener handle method runs	SendWelcomeEmail::handle()	Listener waiting	Listener executed	Welcome email sent to user
6	End	-	-	-	Listener action completed

💡 Listener finished handling event; no more listeners for this event.

Variable Tracker

Variable	Start	After Step 4	After Step 5	Final
$user	undefined	User object created	User object passed to event	User object used in listener
$event	undefined	UserRegistered event created with $user	Passed to listener handle()	Listener finished using event
Listener Registered	false	true	true	true

Key Moments - 3 Insights

Why do we need to register the listener in EventServiceProvider?

Because Laravel only calls listeners that are registered. Step 3 in the execution_table shows adding the listener to the provider so Laravel knows to run it when the event fires.

How does the listener get access to the event data?

The event object is passed as a parameter to the listener's handle method, as shown in Step 5. This lets the listener use event properties like the user.

What triggers the listener to run?

Dispatching the event triggers Laravel to run all registered listeners for that event. Step 4 shows the event being dispatched, which leads to Step 5 where the listener runs.

Visual Quiz - 3 Questions

Look at the execution_table, at which step is the listener registered to the event?

A Step 4

B Step 2

C Step 3

D Step 5

💡 Hint

Check the 'Action' and 'Effect' columns in Step 3 about registering the listener.

At which step does the listener actually perform its action?

A Step 5

B Step 3

C Step 4

D Step 6

💡 Hint

Look for when the listener's handle method runs and sends the email.

If the listener was not registered, what would happen when the event is triggered at Step 4?

A Listener would still run automatically

B Nothing happens; listener does not run

C Laravel would throw an error

D Event would not be created

💡 Hint

Refer to Step 3 and Step 4: registration is needed for Laravel to call the listener.

Concept Snapshot

Creating listeners in Laravel:
1. Define an Event class carrying data.
2. Define a Listener class with a handle() method.
3. Register the listener in EventServiceProvider.
4. Trigger the event in your code.
5. Laravel runs the listener automatically.
Listeners react to events to perform actions like sending emails.

Full Transcript

In Laravel, creating listeners involves defining an event class that carries data, such as a user object. Then, you create a listener class with a handle method that receives the event and performs an action, like sending a welcome email. You must register this listener in the EventServiceProvider so Laravel knows to call it when the event is triggered. When your application dispatches the event, Laravel automatically runs the listener's handle method. This process helps keep your code organized and reactive to important actions.