Programmer avec SPIP 3.0
Documentation technique sur SPIP 3.0

> > > > Qu’est-ce qu’un pipeline ?

Qu’est-ce qu’un pipeline ?

Un pipeline permet de faire transiter un code entre plusieurs intermédiaires (des fonctions) pour le compléter ou le modifier.

Déclaration dans un plugin

Chaque plugin peut utiliser un pipeline existant. Pour cela, il déclare son utilisation dans le fichier plugin.xml de la sorte :

  1. <pipeline>
  2. <nom>header_prive</nom>
  3. <inclure>cfg_pipeline.php</inclure>
  4. </pipeline>

Télécharger

  • Nom : indique le nom du pipeline à utiliser,
  • Inclure : indique le nom du fichier qui contient la fonction à exécuter au moment de l’appel du pipeline (prefixPlugin_nomPipeline()).

Déclaration hors plugin

Une utilisation d’un pipeline en dehors du cadre d’un plugin reste possible. Il faut alors déclarer son utilisation directement dans le fichier config/mes_options.php :

  1. $GLOBALS['spip_pipeline']['nom_du_pipeline'] .= "|nom_de_la_fonction";
  2. // Exemple d'ajout dans le pipeline "insert_head" :
  3. $GLOBALS['spip_pipeline']['insert_head'] .= "|nom_de_la_fonction";
  4.  
  5. function nom_de_la_fonction($flux) {
  6. return $flux .= "Ce texte sera ajoute";
  7. }

Télécharger

La fonction appelée doit être connue au moment de l’appel du pipeline, le plus simple étant de la déclarer comme ici pour la fonction nom_de_la_fonction dans le fichier d’option.

  • En savoir plus !

    À noter que SPIP utilise un cache des pipelines utilisés et que toute nouvelle déclaration nécessite de recalculer ce cache. Cela se fait en visitant la page « Gestion des plugins » dans l’espace privé (?exec=admin_plugin).