Zum Hauptinhalt springen

Plugin-Hooks-Liste

Hinweis

Status: Bearbeitet am 01.05.2022

Nützlich für Administratorinnen

Plugins sind Erweiterungen für Open2C wie beispielsweise der Terminkalender, Passwort-vergessen oder Bildrotation.

Viele dieser Erweiterungen "hängen" (engl. to hook) sich an bestimmte Ereignisse von Open2C, sie benötigen im richtigen Moment eine bestimmte Information oder wollen den Ablauf eines Vorgangs verändern.

Diese Plugins bestimmen während ihres Installationsvorgangs, an welche Ereignisse sie sich "hängen" wollen.

Damit diese Vorgänge für Adminstratorinnen transparent sind und auch zur Fehlerbehebung genutzt werden können, gibt es die Plugin-Hooks-Liste im Verwaltungsbereich.

Klicken Sie auf Plugins verwalten. Oben im horizontalen Seitenkopf finden Sie dann den Link Plugin-Hooks.

Die Hooks sind in folgende Abschnitte sortiert:

  • Frontend-Hooks (Ablaufsteuerung)
  • Frontend-Hooks (Ausgabe)
  • Frontend-Hooks (Ausgabe) veraltet (nur für V2.x - Plugins)
  • Hooks für Backend und Frontend
  • Backend-Hooks

Unter dem englischen Namen des jeweiligen Hooks finden Sie möglicherweise ein oder mehrere von Plugins registrierte Methoden und den Status, ob das Plugin und damit die Funktion des Hooks aktuell aktiv oder inaktiv ist.

Im Bereich Aktionen haben Sie zusätzlich die folgenden Möglichkeiten:

  • nach oben schieben: bei mehreren registrierten Funktionen am gleichen Hook deren Reihenfolge verändern. Damit kann man Plugins priorisieren, wenn es notwendig sein sollte.

  • aktivieren und deaktivieren: bei potentiellen Fehlern oder Fehlerbehebungen nützlich.

Nützlich für Entwicklerinnen

Im Beispiel-Plugin von Open2C (examplev3) ist im Quellcode dokumentiert, wie man eigene PHP-Klassenmethoden im eigenen Plugin an Hooks registrieren kann.

Mithilfe der Plugin-Hooks-Liste bekommt man eine Vorstellung, mit welche(n) Hook-Registrierung(en) man eine bestimmte Aufgabe lösen könnte.

Das Auditor Plugin hängt sich z.B. beinahe an jeden verfügbaren Hook um Vorgänge im System zu protokollieren.

Andere Plugins nutzen z.B. den change_teaser Hook um Teaser-Daten vor der Template-Übergabe zu verändern.