DocumentationCommerceGuide de configuration

[PaaS uniquement]{class="badge informative" title="S’applique uniquement aux projets Adobe Commerce on Cloud (infrastructure PaaS gérée par Adobe) et aux projets On-premise."}

Configuration d’une tâche cron personnalisée

Last update: Tue Oct 07 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Expérimenté
  • Administration
  • Développeur

Ce tutoriel détaillé explique comment créer une tâche cron personnalisée et éventuellement un groupe cron dans un exemple de module. Vous pouvez utiliser un module que vous avez déjà ou vous pouvez utiliser un exemple de module de notre référentiel de magento2-samples.

L’exécution de la tâche cron entraîne l’ajout d’une ligne au tableau cron_schedule avec le nom de la tâche cron, custom_cron.

Nous vous montrons également comment créer, de manière facultative, un groupe cron que vous pouvez utiliser pour exécuter des tâches cron personnalisées avec des paramètres autres que les valeurs par défaut de l’application Commerce.

Dans ce tutoriel, nous supposons que :

  • L’application Commerce est installée dans /var/www/html/magento2
  • Votre nom d’utilisateur et votre mot de passe de base de données Commerce sont tous deux magento
  • Vous effectuez toutes les actions en tant que ​ propriétaire du système de fichiers ​

Étape 1 : obtenir un exemple de module

Pour configurer une tâche cron personnalisée, vous avez besoin d’un exemple de module. Nous vous suggérons le module magento-module-minimal.

Si vous disposez déjà d’un exemple de module, vous pouvez l’utiliser ; ignorez cette étape et l’étape suivante et continuez avec l’Étape 3 : Créer une classe pour exécuter cron.

Pour obtenir un exemple de module :

  1. Connectez-vous à votre serveur Commerce en tant que propriétaire du système de fichiers ou passez à ce dernier.

  2. Accédez à un répertoire qui ne se trouve pas à la racine de votre application Commerce (par exemple, votre répertoire personnel).

  3. Clonez le référentiel magento2-samples.

    code language-bash 
    git clone git@github.com:magento/magento2-samples.git

    Si la commande échoue avec le Permission denied (publickey). d’erreur, vous devez ajouter votre clé publique SSH à GitHub.com.

  4. Créez un répertoire dans lequel copier l’exemple de code :

    code language-bash 
    mkdir -p /var/www/html/magento2/app/code/Magento/SampleMinimal

  5. Copiez l’exemple de code de module :

    code language-bash 
    cp -r ~/magento2-samples/sample-module-minimal/* /var/www/html/magento2/app/code/Magento/SampleMinimal

  6. Vérifiez que les fichiers ont bien été copiés :

    code language-bash 
    ls -al /var/www/html/magento2/app/code/Magento/SampleMinimal

    Le résultat devrait être le suivant :

    code language-none 
    drwxrwsr-x.   4 magento_user apache  4096 Oct 30 13:19 .
drwxrwsr-x. 121 magento_user apache  4096 Oct 30 13:19 ..
-rw-rw-r--.   1 magento_user apache   372 Oct 30 13:19 composer.json
drwxrwsr-x.   2 magento_user apache  4096 Oct 30 13:19 etc
-rw-rw-r--.   1 magento_user apache 10376 Oct 30 13:19 LICENSE_AFL.txt
-rw-rw-r--.   1 magento_user apache 10364 Oct 30 13:19 LICENSE.txt
-rw-rw-r--.   1 magento_user apache  1157 Oct 30 13:19 README.md
-rw-rw-r--.   1 magento_user apache   270 Oct 30 13:19 registration.php
drwxrwsr-x.   3 magento_user apache  4096 Oct 30 13:19 Test

  7. Mettez à jour la base de données et le schéma Commerce :

    code language-bash 
    bin/magento setup:upgrade

  8. Nettoyez le cache :

    code language-bash 
    bin/magento cache:clean

Étape 2 : vérifier l’exemple de module

Avant de poursuivre, vérifiez que l’exemple de module est enregistré et activé.

  1. Exécutez la commande suivante :

    code language-bash 
    bin/magento module:status Magento_SampleMinimal

  2. Assurez-vous que le module est activé.

    code language-none 
    Module is enabled
TIP
Si la sortie indique que l’Module does not exist, passez en revue Étape 1 avec soin. Vérifiez que votre code se trouve dans le bon répertoire. L’orthographe et la casse sont importantes ; si quelque chose est différent, le module ne se charge pas. N'oubliez pas non plus de courir magento setup:upgrade.

Étape 3 : créer une classe pour exécuter cron

Cette étape présente une classe simple pour créer une tâche cron. La classe écrit uniquement une ligne dans le tableau cron_schedule qui confirme qu’elle a été configurée avec succès.

Pour créer une classe :

  1. Créez un répertoire pour la classe et modifiez-le :

    code language-bash 
    mkdir /var/www/html/magento2/app/code/Magento/SampleMinimal/Cron && cd /var/www/html/magento2/app/code/Magento/SampleMinimal/Cron

  2. Un fichier nommé Test.php a été créé dans ce répertoire avec le contenu suivant :

    code language-php 
    <?php
namespace Magento\SampleMinimal\Cron;

use Psr\Log\LoggerInterface;

class Test {
    protected $logger;

    public function __construct(LoggerInterface $logger) {
        $this->logger = $logger;
    }

   /**
    * Write to system.log
    *
    * @return void
    */
    public function execute() {
        $this->logger->info('Cron Works');
    }
}

Étape 4 : Créer Un crontab.xml

Le fichier crontab.xml définit un planning d’exécution de votre code cron personnalisé.

Créez un crontab.xml comme suit dans le répertoire /var/www/html/magento2/app/code/Magento/SampleMinimal/etc :

<?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 name="custom_cronjob" instance="Magento\SampleMinimal\Cron\Test" method="execute">
            <schedule>* * * * *</schedule>
        </job>
    </group>
</config>

L’crontab.xml précédente exécute la classe Magento/SampleMinimal/Cron/Test.php une fois par minute, ce qui entraîne l’ajout d’une ligne au tableau cron_schedule.

Pour rendre la planification cron configurable à partir de l’administration, utilisez le chemin de configuration de votre champ de configuration système.

<?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 name="custom_cronjob" instance="Magento\SampleMinimal\Cron\Test" method="execute">
            <config_path>system/config/path</config_path>
        </job>
    </group>
</config>

Où system/config/path est un chemin de configuration système défini dans le etc/adminhtml/system.xml d’un module .

Étape 5 : Compilation et nettoyage du cache

Compilez le code avec cette commande :

bin/magento setup:di:compile

Et nettoyez le cache avec la commande suivante :

bin/magento cache:clean

Étape 6 : vérification de la tâche cron

Cette étape montre comment vérifier le traitement cron personnalisé avec succès à l’aide d’une requête SQL sur la table de base de données cron_schedule.

Pour vérifier cron :

  1. Exécutez les traitements cron Commerce :

    code language-bash 
    bin/magento cron:run

  2. Saisissez la commande magento cron:run deux ou trois fois.

    La première fois que vous saisissez la commande, elle met les tâches en file d’attente ; par la suite, les tâches cron sont exécutées. Vous devez saisir la commande au moins deux fois.

  3. Exécutez le SELECT * from cron_schedule WHERE job_code like '%custom%' de requête SQL comme suit :

    1. Enter mysql -u magento -p

    2. À l’invite de mysql>, saisissez use magento;

    3. Enter SELECT * from cron_schedule WHERE job_code like '%custom%';

      Le résultat doit être similaire à ce qui suit :

      code language-none 
      +-------------+----------------+---------+----------+---------------------+---------------------+---------------------+---------------------+
| schedule_id | job_code       | status  | messages | created_at        | scheduled_at        | executed_at         | finished_at     |
+-------------+----------------+---------+----------+---------------------+---------------------+---------------------+---------------------+
|        3670 | custom_cronjob | success | NULL     | 2016-11-02 09:38:03 | 2016-11-02 09:38:00 | 2016-11-02 09:39:03 | 2016-11-02 09:39:03 |
|        3715 | custom_cronjob | success | NULL     | 2016-11-02 09:53:03 | 2016-11-02 09:53:00 | 2016-11-02 09:54:04 | 2016-11-02 09:54:04 |
|        3758 | custom_cronjob | success | NULL     | 2016-11-02 10:09:03 | 2016-11-02 10:09:00 | 2016-11-02 10:10:03 | 2016-11-02 10:10:03 |
|        3797 | custom_cronjob | success | NULL     | 2016-11-02 10:24:03 | 2016-11-02 10:24:00 | 2016-11-02 10:25:03 | 2016-11-02 10:25:03 |
+-------------+----------------+---------+----------+---------------------+---------------------+---------------------+---------------------+

  4. (Facultatif) Vérifiez que les messages sont écrits dans le journal système de Commerce :

    code language-bash 
    cat /var/www/html/magento2/var/log/system.log

    Vous devriez voir une ou plusieurs entrées comme celle-ci :

    code language-none 
    [2016-11-02 22:17:03] main.INFO: Cron Works [] []

    Ces messages proviennent de la méthode execute dans Test.php :

    code language-php 
    public function execute() {
     $this->logger->info('Cron Works');

Si la commande SQL et le journal système ne contiennent aucune entrée, exécutez la commande magento cron:run plusieurs fois de plus et patientez. La mise à jour de la base de données peut prendre un certain temps.

Étape 7 (facultatif) : Configurez un groupe cron personnalisé

Cette étape montre comment configurer de manière facultative un groupe cron personnalisé. Vous devez configurer un groupe cron personnalisé si vous souhaitez que votre tâche cron personnalisée s’exécute selon un planning différent des autres tâches cron (généralement, une fois par minute) ou si vous souhaitez que plusieurs tâches cron personnalisées s’exécutent avec des paramètres différents.

Pour configurer un groupe cron personnalisé, procédez comme suit :

  1. Ouvrez crontab.xml dans un éditeur de texte.

  2. Remplacez <group id="default"> par <group id="custom_crongroup">

  3. Quittez l’éditeur de texte.

  4. Créez des /var/www/html/magento2/app/code/Magento/SampleMinimal/etc/cron_groups.xml avec les contenus suivants :

    code language-xml 
    <?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/cron_groups.xsd">
    <group id="custom_crongroup">
        <schedule_generate_every>1</schedule_generate_every>
        <schedule_ahead_for>4</schedule_ahead_for>
        <schedule_lifetime>2</schedule_lifetime>
        <history_cleanup_every>10</history_cleanup_every>
        <history_success_lifetime>60</history_success_lifetime>
        <history_failure_lifetime>600</history_failure_lifetime>
        <use_separate_process>1</use_separate_process>
    </group>
</config>

Pour une description de la signification des options, voir Personnalisation de la référence crons.

Étape 8 : vérifier votre groupe cron personnalisé

Cette étape facultative indique comment vérifier votre groupe cron personnalisé à l’aide de l’Administration.

Pour vérifier votre groupe cron personnalisé :

  1. Exécutez les tâches cron Commerce pour votre groupe personnalisé :

    code language-bash 
    php /var/www/html/magento2/bin/magento cron:run --group="custom_crongroup"

    Exécutez la commande au moins deux fois.

  2. Nettoyez le cache :

    code language-bash 
    php /var/www/html/magento2/bin/magento cache:clean

  3. Connectez-vous à l’administrateur en tant qu’administrateur.

  4. Cliquez sur Magasins > Paramètres > Configuration > Avancé > Système.

  5. Dans le volet de droite, développez Cron.

    Le groupe cron se présente comme suit :

    Votre groupe cron personnalisé

recommendation-more-help
386822bd-e32c-40a8-81c2-ed90ad1e198c