Plugin Schritt für Schritt schreiben

Erstellen Sie ein Plugin für Bludit CMS

Die Entwicklung eines eigenen Plugins für das beliebte CMS Bludit ist wirklich ganz einfach. Der Beitrag zeigt Ihnen Schritt für Schritt wie Sie vorgehen müssen um an Ihr Ziel zu gelangen.

Plugin Struktur

Die Ordner und Verzeichnisstruktur für Bludit-Plugins ist zunächst fest vorgegeben. Schauen Sie sich bestehende Plugins an, dann können Sie die folgende Struktur erkennen:

bl-plugins
    |
    +-- ihr-plugin-ordner
    |          |
    |          +-- languages
    |          |       |
    |          |     de_DE.json
    |          |
    |        metadata.json
    |          |
    |        plugin.php
    .          .

Code

Innerhalb des Ordner bl-plugins können Sie einen eigenen Ordner nach belieben anlegen und einen sinnvollen Namen vergeben.

metadata.json

In der Datei metadata.json tragen Sie Ihre Angaben zum Plugin ein, welche für den Anwender im Backend öffentlich sichtbar sein sollen. Orientieren Sie sich dabei an den folgenden Vorgaben:

{
    "author":      "Bludit",
    "email":       "",
    "website":     "https://plugins.bludit.com",
    "version":     "3.13.1",
    "releaseDate": "2020-07-28",
    "license":     "MIT",
    "compatible":  "3.13.1",
    "notes":       ""
}

Code

Wichtige Informationen sind author, email, website und version.

Die Bludit Plugin Sprachdatei

In der Datei languages/de_DE.json finden Sie weitere Informationen die Sie angeben sollten, damit andere und Sie selbst später noch verstehen was dieses Plugin tut.

{
    "plugin-data":
    {
        "name": "Plugin-Name",
        "description": "Beschreibung des Plugins, ein kurzer Satz sollte reichen."
    }
}

Code

Während plugin-data vorgegeben ist, können Sie die Inhalte bei name und description frei vergeben. Sofern Sie in einem anderen Land als Deutschland leben, müssen Sie natürlich die Sprachdatei anpassen die für Ihre Region zuständig ist.

Das Bludit Plugin

Das eigentliche Plugin für das CMS Bludit ist ebenfalls einer fester Namenskonvention unterworfen. Der Dateiname muss zwingend plugin.php lauten.

001  <?php
002      class pluginIhrName extends Plugin {
003          ...
004          ...
099      }
100  ?>

Code

Der Prefix plugin ist fest vorgegeben, den müssen Sie weiterhin verwenden. Diesem Prefix können Sie dann einen eigenen Namen anhängen. Dieser Name muss nicht dem Ordnernamen entsprechen in dem das Plugin liegt (dies wird in vielen Foren falsch beschrieben).

Bludit Hooks

Die so genannten Hooks (engl. für Haken) sind als globale Aufrufe zu verstehen, bei denen sich alle Plugins melden, die auf diesen speziellen Hook lauschen oder hören. Prominente Hooks sind pageBegin() oder pageEnd(), bei denen alle Plugins arbeiten wenn dieser Hook im Template gerufen wird. Eine vollständige Liste aller Bludit Hooks finden Sie hier.

...
<?php Theme::plugins('pageBegin'); ?>
...

Code

Sehen Sie sich die Templates Alternative oder BlogX an, dort finden Sie diese Hooks im Code wieder.

Das Plugin gibt etwas aus (HalloWelt)

Damit das Plug auch tatsächlich etwas tut, reicht es für diesen Beitrag vollkommen aus, wenn das Plugin etwas an das Bludit Template zurück liefert.

001  <?php
002      class pluginHalloWelt extends Plugin {
003          function pageBegin() {
004              return 'HalloWelt hier ist das Plugin';
005          }
006      }
007  ?>

Code

Im Coding oben meldet sich das Plugin beim Template, wenn dieses den Aufruf (pageBegin) sendet und gibt einen freundliches HalloWelt hier ist das Plugin aus.

Weiterführende Links

• Bludit: Plugin Grundlagen
• Bludit: Benutzerdefinierte Hooks