Ajouter une tache CRON dans un plugin SPIP

1. Créer la tâche

NB : Pour notre exemple, j’ai choisi comme tâche de faire une ligne de log avec la fonction spip_log(). Vous pouvez bien entendu remplacer cela par toutes les actions que vous voulez réaliser !

Une tâche c’est une série d’actions à réaliser, que vous aurez programmé en PHP (a priori) pour s’intégrer dans SPIP. Vous pourrez regarder par exemple ce qui est fait dans le noyau pour le traitement des statistiques.

Appelons donc, pour l’exemple, la tâche « une ligne de log » : montravail

Il existe deux mécanismes légèrement différents à ce jour, dépendant de la version de SPIP :

cron_spipbb_cron($time)  {
	// exemple de tâche possible
	spip_log("Mon travail c est juste une ligne de log....");
}

genie_montravail($time)  {
	// exemple de tâche possible
	spip_log("Mon travail c est juste une ligne de log....");
}

Donc selon la version de SPIP pour laquelle vous rédigez votre plugin il vous faudra créer un fichier contenant la fonction idoine.

NB : Vous pouvez envisager de créer une compatibilité entre les deux soit en dupliquant les entrées soit en créant un appel de l’un par l’autre.

2. Ajout d’une entrée dans la liste des tâche à exécuter

Une fois la tâche existante, il faut qu’elle soit « planifiée », c’est-à-dire ajoutée à la liste des tâches planifiées que SPIP réalise déjà.

Dans le fichier plugin.xml on ajoute l’entrée :

<pipeline>
		<nom>taches_generales_cron</nom>
		<inclure>spipbb_pipelines.php</inclure>
</pipeline>

Attention, dans cet exemple : SpipBB est le <prefix> (au sens plugin.xml) de mon plugin.

Dans le ficher spipbb_pipelines.php (qu’il faut créer s’il n’existe pas), on ajoute la partie suivante :

function spipbb_taches_generales_cron($taches_generales){
	$taches_generales['montravail'] = 60 * 10; // par exemple toutes les 10 minutes, ne pas descendre en dessous de 30 secondes !
	return $taches_generales;
}

Mise en œuvre

Il ne faut pas oublier que le lancement de la tâche dépendra de la fréquentation de la page qui contient la balise #SPIP_CRON (par défaut la page sommaire).

Dans cet exemple, on pourra vérifier que dans tmp/spip.log je trouve régulièrement une ligne avec « Mon travail c’est juste une ligne de log »...

Informations complémentaires

Notez bien que vous pouvez donner le nom que vous souhaitez à votre tâche (par ex : nomdelatache et même en créer plusieurs. Mais il faudra bien respecter le fait d’associer le nom de la tâche à la fonction cron_nomdelatache (ou genie_nomdelatache), ainsi que le nom du fichier dans inc/ : inc/nomdelatache.php, et aussi la référence dans la table des tâches $taches_generales['nomdelatache'] .