Plugins

Guite edited this page Nov 12, 2014 · 4 revisions
Clone this wiki locally

Plugins sind eine einfache Möglichkeit, die Funktionen von Modulen zu erweitern. Sie sind kleine PHP-Funktionen, die bei Bedarf in nachgeladen und ausgeführt werden. Gibt zum Beispiel ein News-Modul nur den Benutzernamen und die ID des Autors aus, Du möchtest aber auch noch verschiedene andere Benutzerdaten ausgeben, kannst Du Dir ein Plugin schreiben, das anhand der Benutzer ID die restlichen Daten aus den anderen Modulen holen (Anzahl der Foren-Posts, Datum der Registrierung).

Wo liegen die Plugins?

Zikula liefert schon eine Menge Plugins - viele Module bringen eigene Plugins mit. Entsprechend verteilt über die Installation sind die Plugins zu finden.

  • Jedes Modul kann ein eigenes /plugins Verzeichnis haben.
  • In jedem Theme kann es ein /plugin-Verzeichnis geben.
  • Und in der /config kann es auch ein /plugin-Verzeichnis geben.

In all diesen Verzeichnissen sucht Zikula nach einem Plugin, wenn es aufgerufen wird. Dabei ist zu bedenken, dass es zum Einen nur in den Verzeichnissen des aktiven Moduls sucht und dass es zum Anderen in einer bestimmten Reihenfolge sucht:

  • /config/plugins/MODULNAME
  • /themes/THEMENAME/plugins/
  • /themes/THEMENAME/templates/MODULNAME/plugins/
  • /modules/MODULNAME/pntemplates/plugins

Wer die Plugins eines anderen Moduls mitbenutzen will, kann mit einer kleinen Datei darauf hinweisen. Diese Datei heißt "usemodules.txt" und enthält einfach die Namen der anderen zu durchsuchenden Module in jeweils einer neuen Zeile. Diese Datei legt man dann einfach in /modules/MODULNAME/pntemplates/plugins - so benutzt zum Beispiel Dizkus die Funktionen von BBCode mit.

Wie weiß ich, wie ein Plugin funktioniert?

In der automatisch erzeugten API-Dokumentation gibt es eine Übersicht aller Core-Plugins. Hier in der linken Spalte findest Du die Plugins, die den verschiedenen Modulen beigelegt sind. Am Namen kannst Du oft schon erkennen, was das Plugin macht. Um genauer zu sehen, wie man das Plugin aufruft, klickst Du es an und liest Dir die Beschreibung in der Mitte an. Eine Übersicht der wichtigsten Plugins gibt es auf dem Zikula Cheatsheet

Links