Anf?nger der WordPress -Plugin -Entwicklung: Verwenden Sie WordPress Plugin -Kessel

WordPress-Plug-In-Entwicklung verfügt über eine niedrige Lernkurve und es gibt keine einzige M?glichkeit, Plug-Ins zu erstellen. Plugins k?nnen so einfach sein wie Hello Dolly, nur eine einzige Datei. Die WordPress-Plugin-Kesselplatte ist so konzipiert, dass Sie eine standardisierte, qualitativ hochwertige Grundlage bieten, mit der Sie Ihr n?chstes gro?artiges Plugin erstellen k?nnen. Im ersten Teil dieser Serie werden wir die Tiefe der Boilerplate, einschlie?lich der Struktur von Dateien und Ordnern sowie die Codeorganisation der Boilerplate, untersuchen.

Schlüsselpunkte

• WordPress-Plugin-Kesselplatte bietet eine standardisierte, qualitativ hochwertige Grundlage zum Erstellen von WordPress-Plugins mit einer niedrigen Lernkurve und kann flexibel für einfache oder komplexe Plugin-Strukturen verwendet werden.
• Die 3.0.0-Version der Boilerplate hat erhebliche Verbesserungen bei der Trennung der Codeorganisation und der internen Bedenken zwischen Plug-Ins mitgebracht und kann einfach durch Klonen des Git-Repositorys oder durch das Herunterladen von Zip-Dateien aus dem GitHub-Repository erhalten werden.
• Die Boilerplate folgt den empfohlenen WordPress -Codierungs- und Dokumentationsstandards, bietet nützliche Starter -Anleitungen und Toolempfehlungen und enth?lt fünf Standardklassen für eine Vielzahl von Funktionen, was es zu einem hervorragenden Ausgangspunkt für Plugin -Entwickler macht.

Hintergrund

Die WordPress-Plugin-Kesselplatte wurde ursprünglich von Tom McFarlin initiiert, um einen standardisierten objektorientierten Ansatz zum Erstellen von WordPress-Plugins bereitzustellen. Da die Boilerplate auf der Plug-in-API aufgebaut ist und den von WordPress empfohlenen Codierungs- und Dokumentationsstandards folgt, k?nnen Sie sicher sein, dass Sie sich in einer sicheren und zuverl?ssigen Umgebung befinden. Die Boilerplate wurde kürzlich auf Version 3.0.0 aktualisiert, wodurch erhebliche Verbesserungen der Codeorganisation und die weitere Trennung des internen Fokus von Plugins erh?ht werden. Wenn Sie bereits mit der Entwicklung von Plugins mit Legacy -Boilerplate (V2.6.2) vertraut sind, kann es einige Zeit dauern, was in der neuesten Version neu ist, einschlie?lich der neuen Ordnerstruktur. Diese Kesselplatte wird nicht mehr von Tom McFarlin selbst (zum Zeitpunkt des Schreibens) aufrechterhalten, und er hat den Stab an Devin Vinson weitergegeben. Die Entwicklung dauert immer noch wie geplant. Melden Sie sie also in Ihrem Github -Repository, wenn Sie Fragen haben. Wir begrü?en auch Ihren Beitrag.

Holen Sie sich eine Vorlagenkopie

Der einfachste Weg, um eine Kesselkopie des WordPress -Plugins zu erhalten, besteht darin, das Git -Repository selbst zu klonen.

<code>git clone https://github.com/DevinVinson/WordPress-Plugin-Boilerplate.git</code>

Oder Sie k?nnen ZIP -Dateien jederzeit aus Ihrem GitHub -Repository herunterladen. Da Version 3.0.0 ver?ffentlicht wird, k?nnen Sie das Plugin nicht einfach direkt in Ihr WP-In-Content/Plugins-Verzeichnis kopieren. Dies liegt daran, dass der tats?chliche Quellcode des Plugins nicht im Root -Verzeichnis enthalten ist, sondern sich tats?chlich in einem Unterverzeichnis namens Trunk befindet. Mach dir jetzt keine Sorgen, wir werden die neue Ordnerstruktur sp?ter in diesem Artikel diskutieren. Die Datei ReadMe.md beschreibt eine vollst?ndige Beschreibung der ordnungsgem??en Installation der Boilerplate. Kurz gesagt, Sie k?nnen:

• Kopieren Sie das Trunk-Verzeichnis in den Ordner WP-Content/Plugins
• Kopieren Sie das gesamte Boilerplate-Verzeichnis und erstellen Sie einen symbolischen Link zu WP-Content/Plugins/
/für das Kofferraum-Unterverzeichnis. Das Erstellen eines symbolischen Links h?ngt von dem von Ihnen verwendeten Betriebssystem ab.

Nachdem Sie dies getan haben, sollten Sie jetzt ein Plugin namens WordPress Plugin -Boilerplate in der Liste der Plugins im Administratorfeld finden, vorausgesetzt, Sie haben keine ?nderungen an der Boilerplate selbst vorgenommen. Aktivieren Sie einfach das Plugin und beginnen Sie!

Passen Sie das Plug-In mit dem Online-Generator

an Wenn Sie aktiviert sind, haben Sie ein "normales" Plugin, das im Grunde genommen nichts tut - zumindest vorerst. Sie müssen auch die Suche und ersetzen Vorg?nge auf der gesamten Boilerplate-Code-Basis ausführen, die sehr mühsam und zeitaufw?ndig sein k?nnen. Glücklicherweise hat Enrique Chavez einen inoffiziellen Generator erstellt, der den Prozess automatisiert. Besuchen Sie einfach http://www.miracleart.cn/link/6340831392e9cd8af9598274f4b3c5c0

und füllen Sie das Formular am unteren Teil der Seite aus, um eine personalisierte Kopie des Wordpress -Plugin -Tabors zu generieren.

Ordnerstruktur

Schauen wir uns genauer an, wie WordPress -Plugin -Boilerplate 3.0.0 im Vergleich zu ?lteren Versionen organisiert ist. Wie bereits erw?hnt, ist der tats?chliche Plugin -Code in einem Unterverzeichnis namens Trunk und nicht im Stammverzeichnis enthalten. Dies soll den Standards folgen, die im offiziellen WordPress -Plugin -Repository verwendet werden, das drei Hauptverzeichnisse enth?lt: Verm?genswerte, Zweige und Kofferraum. Die Kesselplatte liefert bereits zwei davon: Verm?gen und Kofferraum. Hier sind die vollst?ndigen Verzeichnisse und Dateien, die in der Boilerplate enthalten sind (zum Zeitpunkt des Schreibens):

<code>git clone https://github.com/DevinVinson/WordPress-Plugin-Boilerplate.git</code>

Folgendes ist eine kurze Beschreibung der Funktionen jeder Datei und des Ordners:

• .gitignore: Bietet einen angemessenen Standard .gitignore für die meisten Inhalte, die im Git -Repository nicht vorhanden sind.
• CHANGELOG.md: Standard?nderungsprotokoll für Kesselplatten?nderungen, einschlie?lich des ?nderungsdatums.
• README.md: Ein nützlicher Starter mit den aufgeführten Installationsanweisungen sowie einige andere Teile wie Werkzeugempfehlungen und Best?tigungen.
• assets: Dieses Verzeichnis enth?lt empfohlene Ressourcen, die Sie bereitstellen müssen, wenn Sie das Plugin im WordPress -Plugin -Repository ver?ffentlichen. Alle in diesem Verzeichnis enthaltenen Bilder sind die empfohlene Beschluss zur Ver?ffentlichung.
• trunk: Dies ist das eigentliche Plugin, das Sie entwickeln werden. Es gibt einige Ordner, die die Codebasis in administrative und ?ffentlich ausgerichtete Funktionen unterteilen. Wir werden ausführlich erkl?ren, was jedes Unterverzeichnis bedeutet.
  • admin: Das Verzeichnis enth?lt drei Verzeichnisse, n?mlich admin, css und js. Wie der Name schon sagt, sollten hier alle verwaltungsorientierten Funktionen platziert werden. Standardm??ig werden partials und plugin-name-admin.js Ihrem WP-Admin hinzuzufügen. plugin-name-admin.css bietet gemeinsame Funktionen, bei denen Sie verwaltungsspezifische Hooks definieren k?nnen. class-plugin-name-admin.php
  • : Dieses Verzeichnis ist der Funktionalit?t des Verzeichnisses public sehr ?hnlich. Der einzige Unterschied besteht darin, dass das Verzeichnis admin verwendet wird, um alle ?ffentlich ausgerichteten Funktionscode-Grundlagen zu speichern. public
  • : Eine Startdatei, in der Sie übersetzungsfunktionen für Plugins bereitstellen k?nnen. languages .pot
  : Dies ist wahrscheinlich, dass fast alles Magie passiert. Standardm??ig gibt es fünf Startklassen, die wir im n?chsten Abschnitt diskutieren werden.
  • includes
  : Enth?lt standardm??ig eine Kopie der GPL V2 -Lizenz.
  • LICENSE.txt
  : Der Ausgangspunkt der Plug-in-Readme-Datei. Diese Datei umfasst alle Abschnitte, die Sie weiter ausfüllen k?nnen, um eine gute Plugin -Seite im WordPress -Plugin -Repository bereitzustellen.
  • README.txt
  : Der Einstiegspunkt des Plug-Ins. Hier ist ein g?ngiger Plugin -Dateiheader enthalten, den Sie entsprechend Ihren Einstellungen ?ndern k?nnen. Wenn Sie eine Funktion einfügen müssen, wenn das Plugin aktiviert und/oder deaktiviert wird, wird
  • und plugin-name.php in dieser Datei ebenfalls registriert. register_activation_hook register_deactivation_hook

enthalten Klassen

Wie bereits erw?hnt, gibt es im Verzeichnis

fünf Standardklassen. Mal sehen, was jede Klasse tut:

• class-plugin-name-activator.php: Diese Klasse wird w?hrend der Plug-in-Aktivierung instanziiert. Es hat nur eine statische Methode activate(), die bei register_activation_hook registriert ist. Verwenden Sie diese Klasse, wenn Sie bestimmte Aktionen ausführen müssen, wenn das Plugin aktiviert ist, z. B. das Erstellen einer benutzerdefinierten Tabelle oder das Speichern von Standardoptionen.
• class-plugin-name-deactivator.php: Die entsprechende Kategorie von class-plugin-name-deactivator.php. Es hat auch nur eine statische Methode deactivate(), mit der w?hrend der Plugin -Deaktivierung eine beliebige Funktion ausgeführt werden kann.
• class-plugin-name-i18n.php: Der Ausgangspunkt der Plug-in I18N-Funktion. Es verfügt über eine Eigenschaft $domain, die Plugin -Textfelder gespeichert hat. Diese Eigenschaft kann mithilfe der ?ffentlichen Methode set_domain() festgelegt werden. Schlie?lich wird die load_plugin_textdomain() -Methode in dieser Klasse aufgerufen, wenn das Plugin geladen ist.
• class-plugin-name-loader.php: Die wichtigste Klasse in der Vorlage. Es enth?lt zwei Eigenschaften $actions und $filters, wobei alle im Plugin registrierten Hooks gespeichert werden. Es bietet zwei einfache Wrapper -Funktionen add_action() und add_filter() zum Hinzufügen einer Aktion oder zum Filter zu den Eigenschaften $actions und $filters. Dies ist nicht mit WordPress -Standardfunktionen von WordPress zu verwechseln, da diese Klassen sie nicht direkt registrieren. Alle Hooks werden nur w?hrend einer anderen Methode als add_action() registriert. add_filter() run()
: Eine Klasse, die alle Teile zusammenklebt. Es enth?lt wichtige Informationen zum Plugin, wie z. B. den Namen und die Version des Plugins. Darüber hinaus wird die Abh?ngigkeiten mit der
• -Methode geladen, die die oben genannten vier Klassen enth?lt, und das Plugin -Textfeld wird unter Verwendung der class-plugin-name.php -Methode festgelegt. Alle zuvor registrierten Verwaltungs- und ?ffentlichen Haken k?nnen auch hier definiert werden. Diese Klasse bietet auch einfache GET -Methoden wie load_dependencies(), um den Plugin -Namen zurückzugeben, set_locale(), um die aktuelle Plugin -Version zurückzugeben, und get_plugin_name(), um die Instanz von get_version() zu erhalten. get_loader() class-plugin-name-loader.php

Schlussfolgerung

Kurz gesagt, WordPress -Plugin -Boilerplate bietet einen gro?artigen Ausgangspunkt für Plugin -Entwickler. Es folgt den empfohlenen WordPress -Codierungsstandards sowie den WordPress -Dokumentationsstandards, sodass Sie von Anfang an auf dem richtigen Weg sind. Darüber hinaus wird das Ver?ffentlichen eines WordPress -Plugin -Repositorys einfacher, da die Boilerplate bereits das meiste von dem bietet, was Sie ben?tigen. Sobald wir mit der Code -Organisation und der Ordnerstruktur vertraut sind, werden wir untersuchen, wie Sie im zweiten Teil dieser Serie aktuelle Plugins mithilfe von WordPress -Plugin -Boilerplate entwickeln.

Das obige ist der detaillierte Inhalt vonBeschleunigen Sie die Entwicklung mit dem WordPress -Plugin -Kesselplatte. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!