Queued listeners in Laravel - Mini Project: Build & Apply

Queued Listeners in Laravel

📖 Scenario: You are building a Laravel application that sends a welcome email to users when they register. To improve performance, you want to send the email using a queued listener so the user registration process is fast and the email sending happens in the background.

🎯 Goal: Create an event and a queued listener in Laravel that sends a welcome email after a user registers. You will set up the event, configure the listener to be queued, and register the listener in the event service provider.

📋 What You'll Learn

Create a UserRegistered event class with a public user property.

Create a SendWelcomeEmail listener class that implements ShouldQueue.

In the listener, write a handle method that accepts the UserRegistered event.

Register the listener for the event in EventServiceProvider.

💡 Why This Matters

🌍 Real World

Queued listeners help improve user experience by offloading slow tasks like sending emails to background jobs, making web requests faster.

💼 Career

Understanding queued listeners is essential for Laravel developers working on scalable applications that handle tasks asynchronously.

1

Create the UserRegistered event

Create a Laravel event class called UserRegistered with a public property user and a constructor that accepts a $user parameter and assigns it to the property.

Laravel

<?php

namespace App\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class UserRegistered
{
    use Dispatchable, SerializesModels;

    public $user;

    // Your code here
}

Need a hint?

Remember to add a constructor that sets the user property.

2

Create the SendWelcomeEmail listener with queue support

Create a Laravel listener class called SendWelcomeEmail that implements ShouldQueue. Add the InteractsWithQueue trait. Write a handle method that accepts a UserRegistered event parameter.

Laravel

<?php

namespace App\Listeners;

use App\Events\UserRegistered;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;

class SendWelcomeEmail implements ShouldQueue
{
    use InteractsWithQueue;

    // Your code here
}

Need a hint?

Implement ShouldQueue and add the handle method with the event parameter.

3

Register the listener in EventServiceProvider

In app/Providers/EventServiceProvider.php, add the UserRegistered event and its listener SendWelcomeEmail to the $listen array.

Laravel

<?php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use App\Events\UserRegistered;
use App\Listeners\SendWelcomeEmail;

class EventServiceProvider extends ServiceProvider
{
    protected $listen = [
        // Your code here
    ];
}

Need a hint?

Add the event and listener classes to the $listen array.

4

Dispatch the UserRegistered event after user registration

In your user registration logic, dispatch the UserRegistered event by passing the $user object. Use event(new UserRegistered($user)).

Laravel

<?php

// After user registration
// Your code here

Need a hint?

Use the event() helper to dispatch the event with the user.