Vor einem Monat haben wir unser webZunder WordPress Plugin im WordPress Repository veröffentlichen dürfen. Doch zu Beginn gab es ein paar Hindernisse, die wir überwinden mussten. Im heutigen Artikel wollen wir Ihnen diese Hindernisse aufzeigen und erklären, wie Sie am Ende Ihr Plugin ins WordPress Plugin Repository laden können und worauf Sie achten sollten.

WordPress Plugin Repository

Das Plugin Repository bzw. Plugin Projektverzeichnis von WordPress dient zur Verwaltung der einzelnen Plugins. Pluginentwickler können unter bestimmten Bedingungen Zugriff erhalten und ihr Plugin darüber zum Download und zur Installation bereitstellen. Jedes Plugin welches im Plugin Verzeichnis, sei es nun direkt über die WordPress Webseite oder direkt aus einer WordPress Instanz heraus zu finden ist, befindet sich im besagten Repository. WordPress setzt dafür auf die Versionsverwaltungssoftware SVN. Wenn Sie bis dahin noch nicht mit SVN gearbeitet haben, spätestens hier wird es notwendig.

31706 Plugins waren zum Zeitpunkt als der Artikel verfasst wurde im Plugin Verzeichnis zu finden.

31706 Plugins waren zum Zeitpunkt als der Artikel verfasst wurde im Plugin Verzeichnis zu finden.

Was ist zu beachten?

Das Plugin sollte unter einer Softwarelizenz stehen, die mit der GNU Public License v2 kompatibel ist. WordPress selbst wird unter dieser Lizenz veröffentlicht. Außerdem darf das Plugin nichts illegales oder moralisch anstößiges machen. Zudem dürfen, ohne Zustimmung des Nutzers, keine externen Links auf der Webseite generiert werden. Es gibt noch weitere Punkte die man beachten sollte. Diese wurden in den Plugin Guidelines festgehalten.

Für das Einreichen des Plugincodes wird ein WordPress.org Zugang benötigt. Diese Zugangsdaten benötigen Sie später für die Anmeldung an das WordPress SVN. Das Plugin muss, bevor man einen Zugang zum Repository bekommt, zur Durchsicht eingereicht werden. Dafür nutzt man dieses Formular. Hier sollte man vor allem auf das Feld “Plugin Name” achten. Der Name der hier angegeben wird, wird für die URL genutzt. D.h. wird hier ABC angeben, lautet die spätere URL “wordpress.org/plugins/abc”. Außerdem sollte im Namen auf das Wort “Plugin” verzichtet werden.

Zitat WordPress:

We’re no longer accepting plugins with ‚plugin‘ as a defining term in the slug.

That means your plugin URL would have been wordpress.org/plugins/your-code-plugin (for example) which is rather redundant. If you have a plugin in the WordPress.org Plugins Directory announcing it’s a plugin, that’s overkill.

Doch bedenken Sie, die URL kann niemals wieder geändert werden. Daher sollten Sie sich vorher genaue Gedanken machen, wie Sie das Plugin nennen.

Der Name des Plugins, der auf der Plugin Seite angezeigt wird, wird über eine Readme-Datei generiert. Diese Datei ist neben dem eigentlichen Plugincode besonders wichtig. In dieser Readme-Datei werden alle Inhalte definiert, die auf der Plugin Seite angezeigt werden, also Beschreibung, Installationshinweise, FAQ, Screenshots (zumindest die Beschriftungen) und das Changelog. Um die Erstellung dieser wichtigen Datei zu vereinfachen, empfehlen wir den Readme-Generator von generatewp. Wie so eine Readme-Datei aussehen sollte, hat WordPress im Readme-Standard beispielhaft dargestellt. Haben Sie eine Datei erstellt, können Sie diese mit dem Validator testen.

Nach dem Sie Ihr Plugin zur Durchsicht eingereicht haben, dauert es im Schnitt, je nach dem wie viele Plugins noch mit Ihrem warten, eine Woche bis Sie eine Antwort erhalten. Im positiven Falle wird Ihnen unter “http://plugins.svn.wordpress.org/IHRPLUGINNAME” ein Projektverzeichnis zur Verfügung gestellt. Die zwei wichtigsten Verzeichnisse sind asstes und tags.

In Assets werden Bilder für die Screenshots und der Banner für die Pluginseite abgelegt. Screenshots werden wie folgt benannt: screenshot-1.png usw. Sind in der Readme-Datei 3 Screenshots angeben, so müssen hier drei Screenshots abgelegt werden. Sind hingegen nur zwei in der Readme-Datei, wird der dritte Screenshot ignoriert. Der Banner für die Pluginseite muss in folgenden Größen abgelegt und benannt werden: banner-772×250 und banner-1544×500. Je nach Auflösung entscheidet WordPress, welcher Banner ausgegeben wird. Um vorher zu testen, ob der entworfene Banner gut aussieht, kann man an die Plugin-URL einen Parameter “banner” mit dem Link zum Banner anfügen. WordPress generiert dann anhand der URL eine temporäre Bannergrafik.

Das Verzeichnis “tags” beinhaltet alle Versionen des Plugins. Das heißt gibt es eine Version 1.0 und eine Version 1.1 so müssen beide Versionen imn Unterverzeichnissen mit dem jeweiligen Code abgelegt werden. In der Readme-Datei wird ein Stable Tag definiert. Dieses Tag muss sich im Tags Verzeichnis befinden, damit diese Version zum Download bereitgestellt werden kann. Das Verzeichnis trunk und branches dient zur Entwicklung des Plugins. Diese Verzeichnisse sind vom allem bei einem größeren Entwicklerteam praktisch.

Fazit

Um in das WordPress Repository zu kommen, müssen eingie Hürden gemeistert werden. Die Einen sindgrößer, z.B. die Benennung des Plugins und die Einarbeitung in SVN, die Anderen sind weniger hoch, z.B. die Erstellung einer Readme-Datei und der Grafiken. Aber sobald diese Hindernisse aus dem Weg geräumt sind, steht das eigene Plugin zusammen mit den vielzähligen anderen Plugins der WordPress Gemeinschaft zur Verfügung.

Haben Sie vor ein WordPress Plugin zu entwickeln? Kennen Sie schon das webZunder Plugin? Haben Sie Fragen, dann nutzen Sie einfach das Kommentarfeld unterhalb dieses Artikels.