Toolbox des Smart WordPress-Entwicklers GitHub Plugin Updater

Sie möchten Ihr Plugin nicht im WordPress.org Plugin-Verzeichnis hosten? Natürlich können Sie sich entscheiden, es ist doch eine freie Community. Sie müssen es jedoch irgendwo hosten, damit das Plugin gefunden werden kann, und Sie sollten Ihren Benutzern auch Updates für Ihr Plugin zur Verfügung stellen. 

Die meisten Leute, die sich dafür entscheiden, ihre Plugins nicht auf WordPress.org zu hosten, verwenden normalerweise GitHub, aber WordPress weiß nicht, wie man von GitHub gehostete Plugins aktualisiert. Es benötigt Hilfe. Heute helfen wir Ihnen, WordPress bei der Aktualisierung Ihrer Plugins zu unterstützen, Sie haben es erraten, eine Helferklasse.

In diesem Teil der "Toolbox des Smart WordPress Developer" werden wir den WordPress GitHub Plugin Updater durchlaufen, ein Tool, das den Aktualisierungsprozess für auf GitHub gehostete WordPress-Plugins übernimmt.

Warum GitHub anstelle von WordPress.org verwenden??

Wie jedes andere modulare Content-Management-System verfügt WordPress über ein eigenes Repository für Plugins. Ich wäre nicht falsch, wenn ich sagte, dass das WordPress.org Plugin-Verzeichnis zum Community-Standard für das Hosting kostenloser und Open Source-WordPress-Plugins geworden ist.

Aber wie gesagt, dies ist eine freie Gemeinschaft. WordPress erfordert nicht, dass wir alle Plugins und Designs im WordPress.org Plugin-Verzeichnis hosten. Die Menschen können sich dafür entscheiden, sich davon zu entfernen, und das ist völlig natürlich.

Der erste Ort, an dem Leute ihre WordPress-Plugins nach dem WordPress.org-Plugin-Verzeichnis hosten, ist GitHub. GitHub ist das beste Revisionskontrollsystem namens Git und einer der besten Orte, um Open-Source-Software für den Rest der Welt zugänglich zu machen. Und in den letzten Jahren haben immer mehr WordPress-Entwickler ihre neuen Plugins über GitHub veröffentlicht.

Vorteile und Nachteile des Wechsels vom Plugin-Verzeichnis von WordPress.org zu GitHub

Ich denke, es gibt ein Gleichgewicht zwischen den Vor- und Nachteilen des Hostings von WordPress-Plugins auf GitHub anstelle des WordPress.org-Plugin-Verzeichnisses. Ich werde die darlegen, die mir in den Sinn kommen, aber ich würde auch Ihre Meinung dazu sehr schätzen. Zögern Sie nicht, einen Kommentar in den Kommentaren zu machen, nachdem Sie dies gelesen haben.

Wenn Sie Ihre Plugins auf WordPress.org hosten:

• Sie müssen SVN verwenden.
• Ihr Plugin muss von einem WordPress.org-Überprüfer genehmigt werden, bevor Sie es hochladen können. (Dies ist sowohl ein Vorteil als auch ein Nachteil für mich, da ein zweiter Blick auf den Code gut ist, um Sicherheitslücken zu erkennen.)
• Sie können nur GPL (Version 2 oder höher) als Lizenz verwenden.
• Ihre Plugin-Updates werden Ihren Benutzern schnell mitgeteilt.
• Notfall-Plugin-Updates (aus Sicherheitsgründen) werden automatisch an die Benutzer weitergeleitet.
• Die Leute können Ihr Plugin direkt über ihre Admin-Panels finden, was ein großer Vorteil ist.
• Sie können die Supportforen von WordPress.org verwenden.

Und wenn Sie sich entscheiden, zu GitHub zu wechseln:

• Sie können Git verwenden.
• Sie werden unendlich viel mehr Freiheit haben.
• Sie können andere Lizenztypen verwenden (z. B. MIT oder CC, obwohl CC für Software nicht empfohlen wird)..
• Sie können ein Wiki erstellen, Commits akzeptieren und mit Ihren Benutzern über Probleme sprechen.
• Sie haben keine Bewertungen für Ihre Plugins, was für Feedback schlecht ist.
• Sie müssen dieses Lernprogramm beenden, um Plugin-Updates einfacher bereitzustellen.

Es gibt auch eine nette Debatte über WordPress Tavern, die Sie - ich denke - sollten Sie auch lesen.

Einbindung des WordPress GitHub Plugin Updater in Ihr Plugin

Bereit, Update-Benachrichtigungen für Ihre Benutzer bereitzustellen?

Zunächst müssen Sie natürlich den WordPress GitHub Plugin Updater aus seinem GitHub-Repository herunterladen. Sie brauchen nur die updater.php Datei, also mach dir keine Sorgen über die anderen.

Danach müssen Sie die setzen updater.php Datei irgendwo in Ihrem Plugin-Ordner und fügen Sie sie in Ihr Plugin ein. Zum Beispiel, wenn Sie die updater.php Datei in einem Ordner namens github-plugin-updater Wenn Sie es in Ihre Hauptplugin-Datei aufnehmen möchten, müssen Sie der Datei die folgende Zeile hinzufügen:

Sie müssen auch das initialisieren WP_GitHub_Updater Klasse mit den richtigen Argumenten, um Ihr Plugin mit Ihrem GitHub-Repo zu verbinden:

 plugin_basename (__FILE__), 'proper_folder_name' => 'plugin-name', 'api_url' => 'https://api.github.com/repos/username/repository- name', 'raw_url' => 'https: / /raw.github.com/benutzername/repository-name/master ',' github_url '=>' https://github.com/benutzername/repository-name ',' zip_url '=>' https://github.com / username / repository-name / zipball / master ',' sslverify '=> true,' erfordert '=>' 3.0 ',' getestet '=>' 3.3 ',' readme '=>' README.md ',' access_token '=> "); neuer WP_GitHub_Updater ($ config);?>

• Schnecke: Die Schnecke deines Plugins.
• Ordnername_Name: Der Name des Ordners Ihres Plugins.
• api_url: API-URL Ihres GitHub-Repos.
• raw_url: Die rohe URL Ihres GitHub-Repos.
• github_url: Die URL Ihres GitHub-Repos.
• zip_url: Die ZIP-URL Ihres GitHub-Repos.
• sslverify: Ob SSL überprüft werden soll oder nicht.
• erfordert: Die minimale WordPress-Version, die Ihr Plugin benötigt.
• geprüft: Die maximale WordPress-Version, mit der Sie Ihr Plugin getestet haben.
• Readme (veraltet): Die README-Datei, von der die Plugin-Version überprüft werden soll.
• Zugangstoken: Ihr GitHub-Zugriffstoken, wenn Sie ein privates Repo verwenden.

Um Ihre Benutzer zu benachrichtigen, müssen Sie lediglich die Version des Plugins in den Kopfzeilen Ihrer Hauptdatei ändern. (Es scheint, dass dieses Tool verwendet wurde, um die README-Datei auf eine Zeile zu prüfen, die enthält ~ Aktuelle Version: X.X ~ ab Version 1.6 wird jedoch zuerst nach der Haupt-Plugin-Datei gesucht.)

Und das ist es! Wenn Sie diese Schritte ausführen, werden Aktualisierungsbenachrichtigungen für Ihr Plugin aktiviert.

Heute einpacken

Wenn Sie Ihr WordPress-Plugin auf GitHub hosten und Aktualisierungsbenachrichtigungen für Ihre Benutzer bereitstellen möchten, ist der WordPress GitHub Plugin-Updater eines der wichtigsten Tools, das Sie verwenden sollten.

Was denkst du über dieses Tool oder über das Hosting von WordPress-Plugins auf GitHub im Allgemeinen? Teilen Sie uns Ihre Gedanken mit, indem Sie im Kommentarabschnitt unten kommentieren. Und wenn Ihnen der Artikel gefallen hat, vergessen Sie nicht, ihn mit Ihren Freunden zu teilen!