Anfängerleitfaden für die Entwicklung des WordPress-Plugins

Das WordPress-CMS hat das Gesicht unseres Internets verändert und neue Ideen zum Gedeihen gebracht. Die Open-Source-Bewegung hat eine starke Präsenz in der Software- und Webentwicklung. WordPress ist eine Blogging-Plattform, über die viele andere Skripts wie Webforen, Jobbörsen und sogar ein klassisches Webseiten-Content-Management-System aufgerufen werden können.

Wir werden einige Möglichkeiten besprechen, um mit der Plug-In-Entwicklung für WordPress zu beginnen. Die Schritte sind ziemlich einfach und erfordern keine große Hingabe zum Lernen. Grundlegende PHP-Kenntnisse sind selbst bei grundlegendem Verständnis der WordPress-Dateistruktur und des Verwaltungsfensters hilfreich.

In diesem kurzen Tutorial werden die grundlegenden Schritte beschrieben, die zum Erstellen eines einfachen WordPress-Plug-Ins erforderlich sind. Die Funktionalität wird verwendet, um dynamische Auszüge basierend auf der in unseren Funktionsaufruf übergebenen Nummer zu erstellen. Sie müssen die Plug-In-Datei hochladen und über das Admin-Fenster aktivieren. Anschließend rufen Sie unsere Funktion von allen Seiten auf, auf denen der Auszug angezeigt werden soll. Links zu fertiggestelltem Plug-In-Quellcode werden bereits später in diesem Artikel hinzugefügt :)

Warum für WordPress entwickeln??

Plug-Ins sind eine großartige Möglichkeit, die Funktionalität Ihres Blogs durch Hinzufügen zusätzlicher Funktionen zu verbessern. Diese können durch Funktionshaken an beliebiger Stelle in Ihrer Vorlage platziert werden. Im Laufe der Zeit hat die Erweiterbarkeit des Plug-in-Systems von WordPress ein enormes Wachstum und hunderte von Entwicklern ermöglicht, die vom Entwickler eingereicht wurden.

WordPress bietet in seinem CMS speziell solche erweiterten Funktionen, dass es nur wenige einzigartige Plug-Ins gibt. Als Entwickler haben Sie die vollständige Kontrolle über die Backend-Besonderheiten Ihres Weblogs. Die Erstellung eines System-Plugins durch einen PHP-Entwickler würde viel mehr kosten, als Sie vielleicht denken, und die API ist ziemlich einfach, um damit zu arbeiten und sich selbst zu lernen.

Als sekundäres Argument ist die Entwicklung über WordPress eine gute Übung, um sich in andere Bereiche einzugliedern. Durch das Erstellen kleinerer Plugins und Sidebar-Widgets in WordPress können Sie ein besseres Verständnis dafür entwickeln, wie das Backend-System wirklich funktioniert. Dies ist nicht nur auf WordPress beschränkt, da Sie ein tieferes Verständnis für die große Mehrheit der Content-Systeme erhalten.

1. WP-Ordnerstruktur

Eine Einführung in die WordPress-Ordnerstruktur zeigt die grundlegenden App-Verzeichnisse. Im WP-Inhalt finden Sie eine Plugins Verzeichnis. Hier befinden sich alle Ihre einzelnen Plug-Ins, entweder einzelne Dateien oder ordnungsgemäß benannte Unterverzeichnisse.

Bei kleineren Plug-Ins, für die nur eine einzige .php-Datei erforderlich ist, haben Sie die Möglichkeit, diese direkt im Verzeichnis plug-ins / abzulegen. Wenn Sie jedoch kompliziertere Anwendungen entwickeln, ist es viel sinnvoller, ein Unterverzeichnis zu erstellen, das nach Ihrem Plug-in benannt ist. Im Inneren können Sie JavaScript, CSS und HTML-Dateien zusammen mit Ihren PHP-Funktionen unterbringen.

EIN readme.txt Die Datei kann auch nützlich sein, wenn Sie Ihr Plugin zum Download anbieten möchten. Diese Datei sollte Ihren Namen und die Funktionen des Plugins enthalten. Als Autor können Sie auch Details zu jeder Revision und die neuesten Updates angeben.

2. Starten Sie Ihre PHP-Datei

Beim Erstellen eines neuen Plugins müssen Sie mit einer einfachen PHP-Datei beginnen. Dies kann beliebig benannt werden, sollte aber im Allgemeinen den offiziellen Namen Ihres Plug-Ins widerspiegeln. Ich habe zum Beispiel unseren Basiscode erstellt und meine Datei hongkiat-excerpt.phps genannt.

Die ersten Zeilen Ihres Plug-Ins Muss Kommentarinformationen für die Parsing-Engine sein. Dies ist äußerst wichtig, da WordPress Ihre Datei nicht ohne verarbeiten kann. Nachfolgend finden Sie ein Beispiel für einen Codeausschnitt, den Sie kopieren und an Ihre eigenen anpassen können.

Der Name des Plugins wird bei der Aktivierung in Ihrem Admin-Backend-Fenster angezeigt. Dasselbe gilt für den URI, der im Detailbereich des Plug-In-Bereichs platziert wird. Obwohl es nicht erforderlich ist, eine Version oder Beschreibung anzugeben, wirkt Ihr Plugin jedoch viel professioneller.

3. Namenskonventionen und Best Practices für WordPress

Es gibt mehrere Möglichkeiten, Ihr Plug-in tatsächlich zu strukturieren. Oft werden PHP-Entwickler ein gesamtes Klassensystem erstellen, um Kollisionen mit Funktionen und Variablennamen zu vermeiden. Wenn Sie mit der erweiterten OOP-Funktionalität von PHP nicht vertraut sind, schreiben Sie Ihren Code am besten in Beispielfunktionen.

Für unseren Beispielcode schreiben wir also eine einzige Funktion, um unsere Daten unterzubringen. Wir müssen auch einige Variablen definieren, die für die Implementierung in unseren Vorlagendateien von entscheidender Bedeutung sind. Nachfolgend finden Sie ein Beispielcode aus unserer Plugin-Datei, wobei die Kernlogik entfernt wurde.

Wenn Sie Ihren Beispielcode schreiben, beachten Sie am besten die von WordPress festgelegten Richtlinien und Anleitungen. Da bereits so viele interne Funktionen definiert sind, können Sie Duplikate vermeiden, indem Sie allen Variablen und Funktionsnamen ein Label voranstellen.

In den obigen Beispielen haben wir allen unseren Einstellungsnamen das vorangestellte vorangestellt Hongkiat. Dies kann durch ein beliebiges Schlüsselwort Ihrer Wahl ersetzt werden, das normalerweise mit Ihrem Plugin-Namen zusammenhängt. Der obige Code ist nur Beispieleinstellungen und sollte nicht zu unserem endgültigen Plug-In gehören. Dies soll Ihnen nur einen Einblick geben, wie Ihre Variablennamen und Funktionsaufrufe geschrieben werden sollen.

4. Eintauchen in Filter und Aktionen

Es gibt ein anderes Konzept, das erwähnenswert ist, bevor wir in unseren Rohcode einsteigen. Aktionen und Filter sind zwei völlig unterschiedliche Konzepte, die tief in der Art und Weise, wie sie Plugin-Daten bearbeiten, in Beziehung stehen.

Diese beiden Codebits sind standardmäßig in der WordPress-API enthalten. Filter und Aktionen ermöglichen Plug-in-Entwicklern die Aktualisierung von Codeabschnitten im gesamten WordPress-Administrationsbereich, der sich auf Ihr neues Plug-In bezieht. Dies bedeutet, dass Sie eine neue Registerkarte in der Seitenleiste oder zusätzliche Einstellungslinks für Ihre Plug-In-Optionen hinzufügen können.

Verständnis von add_filter ()

EIN Filter wird für ein wenig Text oder Daten verwendet, die an WordPress übergeben werden. Mit Filtern sind Sie buchstäblich dazu in der Lage Inhalt filtern durch Ihre eigenen benutzerdefinierten Funktionen, um Daten auf beliebige Weise zu ändern.

Sie können beispielsweise einen Filter zum Ändern erstellen $ the_content Dies ist eine von WordPress festgelegte Variable, die den gesamten Post-Inhalt eines WordPress-Artikels enthält. Für unser Plug-In nehmen wir mit $ the_content und die Länge der Zeichen zu einem Auszug verkürzen.

Filter sind praktisch, wenn Sie Plug-Ins schreiben, um das Aussehen und Verhalten Ihres Blogs anzupassen. Diese sind besonders beim Schreiben von Sidebar-Widgets oder kleineren Funktionen zum Ändern der Darstellung eines Beitrags beliebt. Nachfolgend finden Sie eine Beispielcodezeile, die zeigt, wie ein Filter angewendet wird.

add_filter ('wp_title', 'hongkiat_func');

Hier fügen wir dem WordPress-Seitentitel einen Filter hinzu. Dieser Code bezieht sich nicht auf unser offizielles Plugin und wird hier nur als Beispiel verwendet.

Das add_filter Diese Funktion ist in WordPress enthalten und wird verwendet, um einer im Seiteninhalt gefundenen Variablen einen neuen Filter hinzuzufügen. In der Zeile darüber zielen wir ab $ wp_title welches den Titel unserer aktuellen Seite enthält. Wir übergeben diese Variable dann in eine gefälschte Funktion mit dem Titel hongkiat_func () Das könnte dann manipulieren und ein neues Titel-Tag für beliebige Zwecke zurückgeben.

Grundlegendes zu add_action ()

Aktionen ähneln Filtern darin, dass sie nicht mit Datenbits arbeiten, sondern vordefinierte Bereiche in Ihren Vorlagen und im Verwaltungsbereich anvisieren. Als Beispiel können Sie eine Aktion anwenden, wenn Sie den Inhalt einer Seite aktualisieren oder bearbeiten. WordPress bietet eine umfassende Aktionsliste in der API-Dokumentation. Nachfolgend finden Sie eine kleine Liste von Beispielaktionen, mit denen Sie einige der vordefinierten Zielbereiche kennenlernen können.

• publish_post - Wird aufgerufen, wenn ein Beitrag veröffentlicht oder der Status geändert wird “veröffentlicht”
• save_post - Wird aufgerufen, wenn ein Beitrag / eine Seite von Anfang an erstellt oder aktualisiert wird
• wp_head - Wird aufgerufen, wenn die Vorlage geladen wird und die wp_head () Funktion
• loop_end - wird unmittelbar nachdem der letzte Beitrag durch die WordPress-Schleife verarbeitet wurde, aufgerufen
• trackback_post - Wird aufgerufen, wenn ein neuer Trackback in einen Beitrag eingefügt wird

Wieder können wir sehen, wie einfach sich dieses Codebit auf reduziert. Wenn Sie den Unterschied zwischen Aktionen und Filtern verstehen, sind Sie der Erstellung umfassender, funktionierender WordPress-Plugins viel näher. Nachfolgend finden Sie eine weitere Codezeile, mit der eine Aktionsfunktion auf der initialisiert wird save_post Haken. Um es noch einmal zu verdeutlichen, bezieht sich dies nicht auf unser aktuelles Entwicklungs-Plugin und wird nur als Beispielcode verwendet, um das zu verstehen add_action () Funktion.

add_action ('save_post', 'benachrichtigen');

Hier sehen wir ein ähnliches Setup wie zuvor mit add_filter (). Wir benötigen 2 Variablen, die erste enthält den Namen unseres Hooks, auf den wir abzielen. In diesem Fall save_post Das heißt, wenn ein neuer Beitrag gespeichert wird, rufen wir unsere an der zweiten Position definierte Funktion auf (benachrichtigen()). Sie können natürlich benachrichtigen, dass der Name der Funktion, die Sie ausführen möchten, aktualisiert wird. Dies ist jedoch für unser aktuelles Beispiel-Plug-In nicht erforderlich.

Fertigstellung unserer Plugin-Logik

Um unseren Weg zu beenden, werden wir unsere letzte Funktion direkt in unsere Plug-In-Datei einfügen. Die API-Dokumentation ist sehr spezifisch und bietet Entwicklern mit erweiterten Fragen eine hervorragende Ressource. Das Material mag schwierig erscheinen, wenn Sie sich mit PHP nicht auskennen, aber nehmen Sie sich Zeit für die Konzepte, und die Dinge werden natürlich fließen!

Die folgende Funktion sollte direkt nach dem Header-Kommentar Ihres Plugins hinzugefügt werden. Alternativ kann dies auch in Ihrem Thema platziert werden Functions.php Datei. Der Code wird zum Erstellen dynamischer Post-Inhalte basierend auf einem begrenzten Zeichenbereich verwendet.

In unserem Beispiel können wir also nur Ausschnitte von nur 55 Zeichen einschränken hk_trim_content () Funktion. Sie können dieses Bit Code einfach aus einem Sidebar-Widget oder einer Ihrer Designdateien aufrufen, um diese zu ersetzen $ the_content.

= $ limit) array_pop ($ content); $ content = implodieren ("", $ content). '…';  else $ content = implode ("", $ content);  $ content = preg_replace ('/\[.+\>/', ", $ content); $ content = apply_filters ('the_content', $ content); $ content zurückgeben;?> 

Es ist nicht zu erwarten, dass Sie alle hier verwendeten internen Variablen oder Funktionen vollständig verstehen. Ein allgemeines Verständnis dafür, wie Ihre Funktionen geschrieben werden sollten und wie ein Beispielset aussehen würde, ist ein sehr guter Anfang.

Möglicherweise stellen Sie auch fest, dass wir einen Anruf an tätigen apply_filters Das ist eine weitere WordPress-spezifische Funktion. Dies ist ein weiterer Aspekt, den Sie nicht vollständig verstehen müssen, er hilft jedoch bei der zukünftigen Programmierung über WP. Weitere Informationen und häufig gestellte Fragen (FAQs) zum Thema finden Sie auf der Referenzseite apply_filters.

Die Kernfunktion oben wird genannt hk_trim_content (). Dies erfordert nur einen Parameter namens $ limit. Dies könnte auch zu verkürzt werden $ lim Hier sollte eine Ganzzahl gespeichert werden, die angibt, auf wie viele Zeichen sich der Auszug beschränken soll. Der Inhalt wird auf vollständigen Postseiten und auch auf statischen Seiten verwendet (über uns, Kontakt)..

Um diese Funktion aufzurufen, müssen Sie den Parameter daher in unsere Vorlagendateien einfügen. Dies würde irgendwo in Ihrem platziert werden index.php oder loop.php Datei (en) und müssen Sie das Plugin zuerst installieren. Beispiel unten:

Das Plugin installieren und ausführen

Ich habe eine Beispieldatei für das Plugin erstellt, um das Demo zu zeigen, wenn Sie die harte Codierung überspringen möchten. Laden Sie einfach diese Datei herunter (benennen Sie sie in .php um) oder kopieren Sie den Code in ein neues PHP-Dokument und laden Sie ihn in Ihr / wp-content / plugins Verzeichnis.

Wenn Sie fertig sind, möchten Sie auf das WordPress-Administrationsfenster zugreifen und Ihre aktuellen Plug-Ins nach der gerade installierten Demo durchsuchen. Sobald Sie aktiviert sind, wird nichts Neues passieren, bis wir unseren Funktionsaufruf manuell hinzufügen. Navigieren Sie dazu einfach Aussehen -> Editor und suchen single.php.

Diese Datei enthält alle HTML / CSS-Vorlagen für Ihre grundlegende Beitragsseite. Scrollen Sie nach unten, bis Sie gefunden haben der Inhalt() und ersetzen Sie es mit dem obigen Beispielcode. Dies begrenzt alle Ihre Artikelseiten auf 55 Zeichen, unabhängig davon, welche Ansicht verwendet wird. Sie können in dieser Funktion auch ähnliche Seiten in Ihrem Vorlagenverzeichnis hinzufügen, wie z search.php oder Archiv.php.

Fazit

Dies sind einige der Grundlagen, damit Sie mit der WordPress-Entwicklung beginnen können. Das Plugin-System ist umfangreich und enthält viele interne Funktionen. Wenn Sie bereits eine Idee für ein Plug-In haben, testen Sie es mit einer lokalen Installation von WordPress, um diese Themen zu üben.

Wenn Sie von den meisten Informationen immer noch verwirrt sind, können Sie die WordPress-Dokumentation lesen und dort nach Ihrer Antwort suchen. Die Entwicklergemeinde ist voll von hilfreichen Benutzern und die Foren halten Archive mit Fragen aus den vergangenen Jahren bereit.