Schritt 1 - Stellen Sie sicher, dass die Dinge richtig formatiert sind
WordPress selbst hängt von den Headern oben in Ihrer Haupt-Plugin-Datei ab. In vielen Fällen befindet sich diese Datei my-cool-plugin.php
im Hauptverzeichnis Ihres Ordners , wenn Ihr Plugin "My Cool Plugin" ist . Stellen Sie sicher, dass der obere Teil der Datei diesem Format entspricht:
<?php
/*
=== [Plugin Name] ===
Plugin Name: [Plugin name]
Plugin URI: [Website where plugin information can be found - your blog, maybe]
Description: [Short description of your plugin]
Author URI: [Your website]
Author: [Your name]
Version: [This version number]
*/
Das WordPress.org-Repository hängt von Ihrer readme.txt
Datei ab, um eine Beschreibung und eine Download-Seite zu erstellen. Stellen Sie also sicher, dass Ihre readme.txt
Datei dem folgenden Format entspricht:
=== [Plugin Name] ===
Contributors: [Your WordPress.org username]
Donate link: [A site people can go to to give you money]
Tags: [Search terms related to your plugin]
Requires at least: [Minimum version of WordPress required]
Tested up to: [Newest version of WordPress you've tested with]
Stable tag: [This version number]
[Short, one-sentence description of your plugin]
== Description ==
[Long description of your plugin]
== Installation ==
[Steps required to install the plugin]
== Frequently Asked Questions ==
= [A question] =
[An answer]
= [Another question] =
[Another answer]
== Screenshots ==
== Changelog ==
== Upgrade Notice ==
Auf WordPress.org gibt es einen praktischen Readme-Validator, mit dem Sie sicherstellen können, dass Ihre Readme-Datei alles enthält, was sie benötigt. Kopieren und einfügen und es wird überprüft, ob alle Abschnitte vorhanden sind und ob Sie bereit sind.
Schritt 2 - Überprüfen Sie das SVN-Repository
Es ist eine gute Idee, Ihre Entwicklungsversion vom WordPress.org-Plugin-Repository getrennt zu halten. Ja, SVN wird für die Versionskontrolle verwendet, aber WordPress verwendet es eher für das Release-Management. Wenn Sie anfangen, jeden Änderungssatz in das Repository zu übernehmen, treten möglicherweise Probleme auf. Eine Sache, die viele Entwickler tun, ist, lokal mit Git zu entwickeln und dann Ihre Dateien in das Subversion-Repository zu übertragen, wenn Sie bereit sind, eine Version zu erstellen.
Diese Anweisungen setzen voraus, dass Sie einen Windows-Computer verwenden. Wenn Sie einen Mac verwenden, können Sie SCPlugin anstelle von TortoiseSVN verwenden. Die Schritte, die Sie ausführen müssen, sind dieselben. Nur die Kontextmenüs und Screenshots unterscheiden sich aufgrund der Benutzeroberfläche geringfügig. Ich habe keinen Mac, daher kann ich keine Screenshots erstellen, um Sie durch ein Tutorial zu führen ... aber vertrauen Sie mir, es ist der gleiche Vorgang.
Installieren Sie TortoiseSVN, falls Sie es noch nicht haben.
TortoiseSVN ist eine Open Source Subversion GUI für Windows. Vertrauen Sie mir, die Verwendung der GUI ist unendlich einfacher als der Versuch, Dinge über die Befehlszeile zu erledigen. Sie werden auch weniger Probleme haben.
Überprüfen Sie Ihr von WordPress gehostetes SVN-Repository
Suchen Sie einen Ort, an dem Sie die von WordPress gehostete Version Ihres Plugins speichern möchten. Standardmäßig verwende ich /My Documents/WordPress/
für alle meine gehosteten Entwicklungsarbeiten. Klicken Sie mit der rechten Maustaste in den Ordner und wählen Sie "SVN Checkout" aus dem Dropdown-Menü.
Geben Sie im daraufhin angezeigten Dialogfenster die URL Ihres WordPress.org-Plugin-Repositorys ein (ich verwende eine meiner URLs zu Demonstrationszwecken) und wählen Sie den Unterordner aus, den Sie erstellen möchten.
Tortoise wird ein bisschen nachdenken, dann wird es das Repository von WordPress.org herunterziehen. In dem neu erstellten Ordner sind alle erforderlichen Ordner bereits für Sie eingerichtet. Jetzt müssen Sie nur noch kopieren, einfügen und festschreiben ... Schritt für Schritt.
Kopieren Sie Ihre neueste Version in /tags
Hier mache ich die Dinge in den meisten Tutorials rückwärts. Alle anderen werden Ihnen sagen, dass Sie /trunk
zuerst ein Commit durchführen sollen , aber denken Sie daran, dass WordPress /trunk
beim Betrachten von Plugins nur die Readme-Datei verwendet. Wenn Sie also Ihr Plugin einfügen /trunk
und Ihre Netzwerkverbindung verlieren (oder etwas anderes schief geht), bevor Sie ein Tag festschreiben, treten Probleme auf.
In dem /tags
Ordner, erstellen Sie einen Ordner , um das gleiche wie die Version namens Sie für Ihr Plugin veröffentlichen. Wenn Sie also Version 0.1 veröffentlichen, erstellen Sie einen /tags/0.1
Ordner.
Kopieren Sie Ihr gesamtes Plugin in diesen Ordner.
Klicken Sie nun mit der rechten Maustaste in den Ordner und wählen Sie "SVN Commit" aus dem Dropdown-Menü.
Es erscheint ein Fenster, in dem alle Änderungen angezeigt werden (alle neuen Dateien sollten als "nicht versioniert" gekennzeichnet sein).
Aktivieren Sie das Kontrollkästchen neben allen Dateien Ihres Plugins (oder klicken Sie auf "Alle auswählen", um alle auszuwählen).
Geben Sie im Feld oben eine Festschreibungsnachricht ein. Da Sie ein Tag festschreiben, sollten Sie wahrscheinlich Folgendes verwenden:
Tagging Version 0.1 von [My Plugin].
OK klicken.
Wieder wird Tortoise ein paar Minuten nachdenken und Sie dann nach Ihrem WordPress-Benutzernamen und -Kennwort fragen, um sich auf den Server festzulegen. Stellen Sie sie bereit, warten Sie, bis die Dinge erledigt sind, und sagen Sie "Erfolg". Fahren Sie dann mit dem nächsten Schritt fort.
Kopieren Sie Ihre neueste Version in /trunk
Navigieren Sie nun zum /trunk
Ordner des Repositorys und kopieren Sie Ihr Plugin erneut in diesen Ordner. Führen Sie die oben beschriebenen Schritte aus, um Ihre Dateien auszuwählen und das Commit vorzubereiten. Verwenden Sie für eine Nachricht etwas, das erklärt, was die neue Version bewirkt:
Version 0.1 von [Mein Plugin] - fügt Unterstützung für OpenID hinzu.
Sobald alles erledigt ist, müssen Sie nur noch ein wenig warten, bis die Server von WordPress.org aufholen. Sie können an manchen Tagen langsamer sein als an anderen, aber innerhalb einer Stunde sollten Sie Ihre neue Version im Repository sehen.
Aktualisieren eines Plugins auf eine neue Version
Sobald Ihr Plugin in der Wildnis ist, ist die Vorbereitung eines Updates relativ einfach.
Verwenden Sie zunächst den Befehl SVN Update, um sicherzustellen, dass Sie über die neueste Version des Repositorys verfügen. Wenn Sie der einzige Entwickler sind, sollten Sie dies bereits tun. Es wird jedoch empfohlen, vor dem Festschreiben ein Update durchzuführen.
Führen Sie dann den obigen Vorgang durch, um einen neuen Unterordner /tags
für Ihre neue Version zu erstellen . Sagen Sie , /tags/0.2
. Berühren Sie nicht den alten /0.1
Ordner. Es ist aus einem bestimmten Grund da und Sie werden es nie wieder anfassen.
Übernehmen Sie Ihr neues Tag und wechseln Sie in den /trunk
Ordner. Ersetzen Sie alles /trunk
durch Ihre neue Version und verpflichten Sie sich wie oben. Sobald die Server aktualisiert sind, sprechen sie eher über die neue als über die alte Version.