Der Begriff Boilerplate Code wird oft abwertend verwendet, da niemand ihn besonders gerne schreibt (einschließlich WordPress-Entwickler). Es bezieht sich auf Code, der an vielen Stellen ohne Änderung als Gerüst wiederholt wird, bevor Code geschrieben wird, der tatsächlich etwas tut. Einige Sprachen wie Java und C++ wurden dafür kritisiert. Aber all dieses Gerüst gibt es aus einem bestimmten Grund. Das heißt, gute Organisationsprinzipien in der Codestruktur bereitzustellen und durchzusetzen (Best Practices).

Im Zusammenhang mit WordPress-Themes und Plugins werden die Vorteile der Verwendung von Boilerplate-Code klarer und direkter demonstriert. Es gibt mehrere WordPress-Projekte, die eine Sammlung gut durchdachter Boilerplate-Codes bereitstellen, die Ihnen helfen können, Ihren Code zu organisieren und Fehler zu vermeiden.

Was ist Boilerplate-Code?

Boilerplate-Code ist im Grunde ein Skelett aus Verzeichnissen und Quellcodedateien, die Sie bei der Entwicklung Ihres Projekts verwenden können. Die Verzeichnisse helfen dabei, die verschiedenen Quellcodedateien an ihrem richtigen Ort zu organisieren, und normalerweise spiegelt die Struktur die auf Ihrer Entwicklungsplattform wider.

Im Falle von WordPress-Plugins enthalten die Quellcodedateien normalerweise Platzhalterfunktionsdefinitionen, Werte und Kommentare, die beschreiben, welcher Teil des Codes wohin gehört. Boilerplate-WordPress-Themes bieten auch eine Verzeichnisstruktur mit organisierten und kommentierten Skelett-js- und CSS-Dateien.

Vorteile von Boilerplates in der WordPress-Entwicklung

Alle WordPress-Plugins haben einige gemeinsame Funktionen wie Aktivierung, Deaktivierung sowie die verschiedenen Hooks, die sie implementieren müssen. Ein Boilerplate-Code kann eine gemeinsame Struktur bereitstellen, die gut gestaltet ist und bewährte Softwarepraktiken durchsetzt. Es gibt drei gute Dinge, die Sie mit der Verwendung von Boilerplate-Code erreichen: Bessere Codequalität, einfachere Wartung und schnellere Entwicklung. Und diese wiederum machen Sie zu einem besseren WordPress-Entwickler.

Bessere Codequalität

Obwohl die Codequalität des WordPress-Kerns großartig ist, ist dies bei WordPress-Plugins normalerweise nicht der Fall. Eine natürliche Folge der Verwendung von Boilerplates ist die Standardisierung. Plugins, die einem Standard entsprechen, der bewährte Praktiken durchsetzt, einen saubereren Code haben und vor allem am richtigen Ort sind. Boilerplate ermutigt Entwickler auch, die Schnittstelle und Funktionalität des Plugins vollständig zu implementieren. Indem Sie dieses Gerüst bereitstellen, hilft es Ihnen, nichts auszulassen oder an einer falschen Stelle schlecht zu implementieren.

Es ist auch eine große Hilfe für Anfänger von WordPress-Entwicklern, da alles korrekt angeordnet und mit Kommentaren versehen ist.

Einfachere Wartung

All dies führt zu einer einfacheren Wartung. Code, der mithilfe von Boilerplate geschrieben wurde, ist einfacher zu lesen, zu verstehen und zu beheben. Mit der Standardisierung kann ein Entwickler Ihren Code übernehmen und weiß genau, wo er suchen muss. Es ist jedoch nicht nur für die anderen WordPress-Entwickler, sondern auch für Sie selbst. Code, der vor einer Woche geschrieben wurde und noch frisch in Ihrem Gedächtnis ist, wird nach ein paar Monaten schnell unverständlich.

Schnellere Entwicklung

Boilerplate-Code trägt auch dazu bei, die Entwicklungszeiten zu verkürzen. Indem Sie ein vollständiges Arbeitsskelett des Projekts erhalten, können Sie mit dem Schreiben von Code und Design an den wichtigen Stellen beginnen. Sie müssen keine Zeit damit verbringen, Code zu organisieren oder herauszufinden, welche Standardfunktionen oder CSS-Komponenten Sie benötigen, und sie dann zu schreiben.

Aber der größte Gewinn ist, wenn Sie Ihre eigenen, fortschrittlicheren Boilerplate-Pakete erstellen. Wenn Sie normalerweise bestimmte Arten von WordPress-Sites erstellen, z. B. E-Commerce- oder persönliche Seiten, dann passiert die Magie. Sie können ein Paket mit Skelettdateien schreiben, die Platzhaltercode und Themenfunktionen enthalten, die in allen Projekten eines bestimmten Typs gleich sind. Auf diese Weise entpacken Sie einfach das Paket und beginnen, es nur mit den Besonderheiten des Projekts zu füllen.

Hosten Sie Ihre Website mit Pressidium

60- TÄGIGE GELD-ZURÜCK-GARANTIE

SEHEN SIE UNSERE PLÄNE

Wenn Sie ein Pressidium-Kunde sind, können Sie unser Klon-Tool verwenden, das unter Berücksichtigung dieses einfachen Konzepts entwickelt wurde. Angenommen, Sie haben auf der Pressidium-Plattform eine Boilerplate-E-Commerce-WordPress-Site erstellt. Sie klonen es mit nur einem Klick und beginnen dann mit der Arbeit an den Einzelheiten, anstatt jedes Mal von vorne anzufangen.

Boilerplate in WordPress-Projekten verwenden

Es gibt mehrere vorgefertigte „Systeme“ für WordPress. Aber in diesem Artikel werden wir uns auf zwei konzentrieren, die sowohl bekannt als auch dokumentiert sind: Das WordPress-Plugin Boilerplate und roots.io.

Das WordPress-Plugin-Boilerplate bewirbt sich selbst als „standardisierte, organisierte, objektorientierte Grundlage zum Erstellen hochwertiger WordPress-Plugins“ und liefert es auf jeden Fall ab. Es folgt den WordPress-API- und Dokumentationsstandards, baut auf der WordPress-Plugin-API auf und bietet eine saubere Möglichkeit zur Lokalisierung. Werfen wir einen Blick auf seinen Inhalt:

Changelog.md
Dies ist die Changelog-Datei in Markdown.

plugin-name/
Der Hauptordner, der alles andere enthält.

admin/
Alle verwaltungsbezogenen Funktionen sind hier untergebracht. Es enthält drei relevante Ordner, css , js und partials dafür.

includes/
Dieses Verzeichnis enthält Klassen für die Aktivierungs-/Deaktivierungsfunktionalität, die i18n-Lokalisierung und die Loader-Klasse, um alle Funktionen/Hooks zu definieren.

• class-plugin-name-activator.php
• class-plugin-name-deactivator.php
• class-plugin-name-i18n.php
• class-plugin-name-loader.php
• class-plugin-name.php
• index.php

languages/plugin-name.pot
Eine Boilerplate-.pot-Datei, die die lokalisierten Zeichenfolgen für Ihr Plugin enthält.

public/
Hier fügen Sie den gesamten öffentlich zugänglichen Plugin-Code ein. Auch hier haben Sie die relevanten Ordner css , js und partials .

HINWEIS : Bevor Sie beginnen, vergessen Sie nicht, alle „Plugin-Namen“-Vorkommen in den Namen Ihres Plugins umzubenennen.

Unser zweites bevorzugtes Boilerplate-System ist viel komplexer und kann daher in diesem Artikel nicht vollständig behandelt werden. Es verfügt jedoch über eine hervorragende Online-Dokumentation. Die Entwickler haben auch eine Reihe von E-Books für jede Komponente geschrieben, die Sie auf der offiziellen Website erwerben können!

Roots.io ist ein fortschrittliches Boilerplate-System, das drei Komponenten (Trellis, Bedrock und Sage) bietet, die separat oder in Verbindung verwendet werden können. Es wurde entwickelt, um für WordPress-Projekte und nicht nur für Plugins oder Themes verwendet zu werden. Es verfügt über erweiterte Funktionen wie die Bereitstellung virtueller Maschinen durch Vagrant, Abhängigkeitsverwaltung mit Composer, Sass-Unterstützung zum Schreiben von Stylesheets, automatische Javascript-Fehlerkorrektur, Browsertests, Bildoptimierung und mehr. Es basiert auf der HTML5-Boilerplate und wird mit der neuesten Version von Bootstrap geliefert.

Abschließend

Es gibt viele Boilerplate-Systeme, die jeweils unterschiedliche Anforderungen erfüllen. Wählen Sie Roots.io, wenn Sie ein fortgeschrittener WordPress-Entwickler sind, der eine vollständige WordPress-Projektbausteinlösung zusammen mit Integrationsfunktionen und Toolchain benötigt. Wenn Sie ein Anfänger in WordPress-Entwicklern sind oder nur eine einfache Vorlage benötigen, um mit der Entwicklung Ihres Plugins oder Designs zu beginnen, dann ist The WordPress Plugin Boilerplate am besten für Ihre Bedürfnisse geeignet.