How to Create Cron Job in Magento 2

Magento 2 Create Cron Job is setting an automatic schedule on time, that is really convenient when you run Magento 2 store. Why is it such useful function? For example, you need assitance from a software like website statistics or content management system which require to run at the certain time, however, maybe you are unavailable to do that. That is why you must create the cron job on your web server.

Are you looking for a understanable tutorial? This post is all for you. The simple and clear instructions will be mentioned here.

Tables of Contents

• What is Cron Job?
• Why need Cron Job?
• Run and Create Cron Job
  • Create crontab.xml
  • Create Test.php

What is a Cron Job?

Cron job is a great feature by Linux, the free operating system for the user. The cron job will create a command or a script that is appropriate with the task you want to do. Instead of manual working, the cronjob allows running automatically in exact time and date. Due to its automation, the cron jobs is the perfect choice for repeated projects every date or every week.

Note

Cron configuration is very important in Magento to set the schedule for many system activities such as reindexing, auto-update of currency rates, Magento emails, etc. Only when the configuration is correct, the cron job is active. In the case of making an error, this means Magento won’t function as expected.

Why need Cron Job

Several Magento features require at least one cron job, which schedules activities to occur in the future. A partial list of these activities follows:

• Catalog price rules
• Newsletters
• Generating Google sitemaps
• Customer Alerts/Notifications (product price change, product back in stock)
• Reindexing
• Private sales (Magento Commerce only)
• Automatic updating of currency rates
• All Magento e-mails (including order confirmation and transactional)

Run and Create cron job

Please follow the guides to start the cron job program as your wish while the cron schedule is set by you.

• Create a class within the “Cron” folder

• Manually setup the cron schedule by using PHP: bin/magento cron:run

• Find a log in the var/log/system.log after the cronjob has run.

• Login to Magento 2 Admin panel, do as the path: Stores > Configuration > Advanced > System, then changing scheduler settings per cron group.

• Finally, run cron from the command line:

magento cron:run [--group="<cron group name>"]

Now, We will add a custom cron in HelloWorld module.

Create crontab.xml

File: app/code/Mageplaza/HelloWorld/etc/crontab.xml

Content would be

<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
	<group id="default">
		<job instance="Mageplaza\HelloWorld\Cron\Test" method="execute" name="mageplaza_helloworld_cron">
			<schedule>* * * * *</schedule>
		</job>
	</group>
</config>

• group id is your cron group name. You can run only cron for single group at a time.
• job instance is class to be instantiated (classpath).
• job method is method in job instance to call.
• job name is Unique ID for this cron job.
• schedule is schedule in cron format. The following graph shows what it consists of:

* * * * * command to be executed
| | | | |
| | | | +----- Day of week (0 - 7) (Sunday=0 or 7)
| | | +------- Month (1 - 12)
| | +--------- Day of month (1 - 31)
| +----------- Hour (0 - 23)
+------------- Minute (0 - 59)

In crontab.xml, we have defined job instance is Mageplaza\HelloWorld\Cron\Test. It should create now.

Create Test.php

File: app/code/Mageplaza/HelloWorld/Cron/Test.php

Content would be:

<?php

namespace Mageplaza\HelloWorld\Cron;

class Test
{

	public function execute()
	{

		$writer = new \Zend\Log\Writer\Stream(BP . '/var/log/cron.log');
		$logger = new \Zend\Log\Logger();
		$logger->addWriter($writer);
		$logger->info(__METHOD__);

		return $this;

	}
}

All done, please flush cache and run magento cron:run --group="default" from the command line.

To check whether the Cron is working properly, go to var/log/cron.log of your store and you will see the text Mageplaza\HelloWorld\Cron\Test::execute in it.

• 10 Basic Tutorials

• Magento 2 Module Development
• Magento 2 Block Template Ultimate Guides
• How to Create Module in Magento 2
• Create Controller
• Models (CRUD)
• View: Layouts, Block and Templates
• Configuration - System.xml
• Admin Menu
• Admin ACL
• Admin Grid

Meet Mageplaza at Meet Magento Asia