Dokumentation

Konfigurationen

Standard- und Website-Konfigurationen für Plugin-Verhalten.

Allgemein

Konfigurationen definieren, welche Einstellungen ein Plugin anbietet. Im Plugin-Editor wird dafür im Bereich Konfigurationen ein Data-Schema gepflegt. Das Schema beschreibt die Felder; die eigentlichen Werte werden später dort gepflegt, wo das Plugin genutzt wird.

Konfigurationsarten

Es gibt zwei Schema-Bereiche:

  • Standard-Konfiguration: allgemeines Konfigurationsschema des Plugins.
  • Website-Konfiguration: erscheint nur bei Plugins mit Website-Zugriff und wird pro Website gepflegt.

In Konfigurationsschemas steht zusätzlich der Feldtyp Datei zur Verfügung. Website-Konfigurationen mit Datei-Feldern werden zur Laufzeit in nutzbare Dateiobjekte mit URL und Thumbnails aufgelöst.

Website-Konfigurationen

Wenn ein aktives Website-Plugin ein Website-Konfigurationsschema besitzt, ergänzt simplebis die Website-Einstellungen um eine eigene Plugin-Konfigurationskarte. Die Werte werden am Website-Datensatz unter plugin_configurations gespeichert und bleiben pro Website getrennt.

Zur Laufzeit können Website-Komponenten und Plugin-Kontexte diese Werte über api.pluginConfig(...) bzw. pluginConfig(...) lesen. Ohne Argument wird die Konfiguration des aktuellen Plugins geliefert; mit einem Plugin-Key und optionalem Pfad kann gezielt auf ein anderes aktives Plugin zugegriffen werden, zum Beispiel api.pluginConfig("mein-plugin.farbe").

Auswirkungen

Konfigurationen verändern das Verhalten eines Plugins, ohne Code oder Komponenten neu bearbeiten zu müssen. Sie eignen sich für API-Keys, Farben, Standardtexte, Feature-Schalter, Datei-Referenzen, Formularziele, Tracking-Optionen oder andere Werte, die pro Website oder Umgebung unterschiedlich sein können.

Bei Website-Konfigurationen ist wichtig: Nur aktive Website-Plugins mit einem Website-Konfigurationsschema erscheinen in den Website-Einstellungen. Wird ein Plugin auf einer Website deaktiviert, wird seine Konfiguration nicht mehr zur Laufzeit verwendet.