How to Set Cron Job in Laravel 9 using Scheduler?

Mar 02, 2022 . Admin

Hi friends,

This tutorial will give you simple example of how to set cron job in laravel 9 using scheduler?. often we need some task to perform automatically like sending emails, run database query etc. Making a cron job in laravel 9 is simple and easy. we will create fresh Laravel application and set cronjoc using artisan console step by step. As well as learn how to create and configure cron job command in laravel 9 app.

You can done this type functionality using laravel task scheduling. and some configure in your live server. in this post we are give very simple example for laravel cron job from the scratch with example.

Simply follow this step for set scron job in laravel using task scheduling.

Step 1: Download Laravel

Let us begin the tutorial by installing a new laravel application. if you have already created the project, then skip following step.

composer create-project laravel/laravel example-app
Step 2: Create New Command

In this step, we need to create our custom command. custom command will execute with task scheduling scron job. so, let's run bellow command to create new custom command.

php artisan make:command JobCron --command=job:cron

Now make some changes on Command file.

app/Console/Commands/JobCron.php
<?php
  
namespace App\Console\Commands;
  
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Http;
use App\Models\User;
  
class JobCron extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'job:cron';
  
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';
  
    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }
  
    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        info("Cron Job running at ". now());
  
        /*------------------------------------------
        --------------------------------------------
        Write Your Logic Here....
        I am getting users and create new users if not exist....
        --------------------------------------------
        --------------------------------------------*/
        $response = Http::get('https://jsonplaceholder.typicode.com/users');
      
        $users = $response->json();
  
        if (!empty($users)) {
            foreach ($users as $key => $user) {
                if(!User::where('email', $user['email'])->exists() ){
                    User::create([
                        'name' => $user['name'],
                        'email' => $user['email'],
                        'password' => bcrypt('123456789')
                    ]);
                }
            }
        }
  
        return 0;
    }
}
Step 3: Register as Task Scheduler

In this step, we need to define our commands on Kernel.php file with time when you want to run your command like as bellow functions:

->everyMinute();Run the task every minute
->everyFiveMinutes();Run the task every five minutes
->everyTenMinutes();Run the task every ten minutes
->everyFifteenMinutes();Run the task every fifteen minutes
->everyThirtyMinutes();Run the task every thirty minutes
->hourly();Run the task every hour
->hourlyAt(17);Run the task every hour at 17 mins past the hour
->daily();Run the task every day at midnight
->dailyAt(’13:00′);Run the task every day at 13:00
->twiceDaily(1, 13);Run the task daily at 1:00 & 13:00
->weekly();Run the task every week
->weeklyOn(1, ‘8:00’);Run the task every week on Tuesday at 8:00
->monthly();Run the task every month
->monthlyOn(4, ’15:00′);Run the task every month on the 4th at 15:00
->quarterly();Run the task every quarter
->yearly();Run the task every year
->timezone(‘America/New_York’);Set the timezone
app/Console/Kernel.php
<?php
  
namespace App\Console;
  
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
  
class Kernel extends ConsoleKernel
{
    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        $schedule->command('job:cron')
                 ->everyMinute();
    } 
  
    /**
     * Register the commands for the application.
     *
     * @return void
     */
    protected function commands()
    {
        $this->load(__DIR__.'/Commands');
   
        require base_path('routes/console.php');
    }
}
Step 4: Run Scheduler Command For Test

now we are ready to run our cron, so you can manually check using following command of your cron. so let's run bellow command:

php artisan schedule:run

After run above command, you can check log file where we already print some text. so open you your log file it looks like as bellow:

storage/logs/laravel.php
[2022-03-01 03:51:02] local.INFO: Cron Job running at 2022-03-01 03:51:02  
[2022-03-01 03:52:01] local.INFO: Cron Job running at 2022-03-01 03:52:01  
[2022-03-01 03:53:02] local.INFO: Cron Job running at 2022-03-01 03:53:02  
Laravel 9 Cron Job Setup on Server

Here, i will show you how to setup cron job command on server. you need to install crontab on server. if you are using ubuntu server then it already installed. so let's run bellow command and add new entry for cron job.

crontab -e

Now, add bellow line to crontab file. make sure you need to set your project path correctly on it.

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

Now, you can check on server as well.

I hope it can help you...

#Laravel 9