De pipelines gebruiken

Om de pipelines van SPIP of van een plugin te gebruiken, moet je hun toepassing specifiek declareren in het bestand plugin.xml :

<pipeline>
	<nom>naam_van_de_pipeline</nom>
	<action>naam van de te laden functie</action>
	<inclure>map/bestand.php</inclure>
</pipeline>

De parameter action is optioneel, standaard is deze gelijk aan de naam van de pipeline. Deze declaratie geeft aan dat een specifiek bestand moet worden geladen op het moment van aanroepen van de pipeline (bepaald met inclure) en functie prefixPlugin_action() te laden. De parameter action wordt zelden geraadpleegd.

Wanneer meerdere pipelines worden gebruikt, geef je ze als volgt aan:

<pipeline>
	<nom>naam_van_pipeline_1</nom>
	<inclure>map/bestand.php</inclure>
</pipeline>
<pipeline>
	<nom>naam_van_pipeline_2</nom>
	<inclure>map/bestand.php</inclure>
</pipeline>

Voorbeeld

De pipeline insert_head voegt inhoud toe in de <head> van de pagina’s van de publieke site. De plugin "Messagerie" (met "messagerie" als prefix) voegt aldus een CSS stylesheet toe:

<pipeline>
	<nom>insert_head</nom>
	<inclure>messagerie_pipelines.php</inclure>
</pipeline>

En in bestand messagerie_pipelines.php:

function messagerie_insert_head($texte){
	$texte .= '<link rel="stylesheet" type="text/css" href="'.find_in_path('habillage/messagerie.css').'" media="all" />'."\n";
	return $texte;
}

Auteur hanjo Gepubliceerd op:

Vertalingen: English, français, Nederlands