Die WordPress-Einstellungs-API, Teil 1 Was es ist, warum es wichtig ist

Wie wir bereits mehrfach bei WP Tuts erwähnt haben (und Sie haben es zweifellos bemerkt), war es nie besser als WordPress-Entwickler. Ob beim Kunden oder bei der Produktentwicklung (entweder mit Themes oder Plugins), der Einstieg in das WordPress-Ökosystem ist fast eher eine Frage des „Wo“ als des „Wie“.

WordPress bietet eine hervorragende API-Dokumentation für Entwickler, unabhängig vom Erfahrungsstand. Eine aktive Entwicklungscommunity und eine gut dokumentierte API machen eine Plattform jedoch nicht gegen schlechte Entwicklungspraktiken immun.

Wie bei den meisten Aspekten der Webentwicklung bedeutet dies nicht nur, dass etwas richtig gemacht wurde, weil etwas funktioniert. Als Entwickler und Handwerker haben wir jedoch die Aufgabe sicherzustellen, dass die von uns freigegebenen Arbeiten ordnungsgemäß funktionieren und ordnungsgemäß erstellt werden. Wenn Sie den Quellcode für eine Vielzahl von Designs oder Plugins durchgießen, zeigen Sie, dass Entwickler Produkte veröffentlichen, die funktionieren, aber nicht optimal aufgebaut sind. Dies gilt insbesondere in den Bereichen Themenoptionen, Menüseiten, Validierung usw..

Und wir wollen damit aufhören.

In dieser Serie werden wir uns eingehend mit der WordPress-Einstellungs-API beschäftigen. Wir werden uns ansehen, was es ist, warum es wichtig ist und wie wir es in unserer Arbeit nutzen können.

Unser oberstes Ziel ist es, dass diese Serie eine solide Referenz für die Einstellungs-API ist ungeachtet Ihrer Erfahrung. Am Ende sollten Sie ein klares Verständnis der API und solide Beispiele dafür haben, wie Sie die Dinge richtig ausführen.

Um vollständig zu sein, müssen wir am Nullpunkt beginnen. Bevor wir also Code schreiben oder Beispiele durcharbeiten, müssen wir die Einstellungs-API vorstellen, was es ist und warum es wichtig ist.


Die Einstellungs-API wurde definiert

Grundsätzlich besteht die Einstellungs-API aus einer Reihe von Funktionen, die von WordPress bereitgestellt werden. Sie vereinfacht die Einführung von Menüs, Optionsseiten und das Speichern, Überprüfen und Abrufen von Benutzereingaben.

Leicht genug, richtig?

In dieser ganzen Serie werden wir uns mit jedem Aspekt beschäftigen, aber es sollte eine einfache Definition geben, von der aus wir den Rest der Artikel bearbeiten können.

Warum sollten wir die Einstellungs-API verwenden??

Nun, da wir wissen, was die Einstellungs-API eigentlich ist ist, Wir müssen prüfen, warum wir dies verwenden möchten, anstatt Benutzereingaben, Serialisierung und Validierung allein zu handhaben.

Kommuniziert mit WordPress Core

Die Einstellungs-API wird von den Entwicklern der WordPress-Plattform bereitgestellt, um die Erweiterung der Anwendung zu erleichtern. Wäre es nicht sinnvoll, die von den Autoren der Plattform selbst zur Verfügung gestellten Funktionen zu verwenden??

Sicher, es ist absolut möglich, diese Funktionen zu umgehen und unsere eigene Funktionalität "brutal erzwingen". Niemand kann sie wirklich stoppen. Dies erfordert jedoch unnötige Arbeit für uns, ignoriert die Empfehlungen des WordPress Core-Teams und kann letztendlich die zusammenhängende Erfahrung zerstören des Dashboards.

Entscheiden, die bereitgestellten Funktionen zu nutzen zum Entwickler durch Entwickler stellen sicher, dass wir auf korrekte Weise mit der Kernanwendung kommunizieren.

Kostenlose Sachen Out-of-The-Box

Bei der Verwendung der Einstellungs-API muss nicht unbedingt sichergestellt werden, dass wir uns auf die empfohlenen Kanäle der Entwicklung nähern. Es geht auch darum, sicherzustellen, dass unsere Benutzeroberflächen den bewährten Vorgehensweisen der Plattform folgen und dass unsere Daten mit den gleichen Mechanismen, die auch der Rest von WordPress verwendet, bereinigt werden. Es schadet auch nicht, dass es uns auch viel Zeit sparen kann.

Wenn Sie anfangen, Ihre Schnittstellen so zu gestalten, dass sie vorhandene WordPress-Stile nutzen und die Einstellungs-API verwenden, wird Ihre Arbeit viel enger mit dem Rest des Systems integriert.

Das bedeutet, dass Benutzer sich beim Arbeiten mit ihrem Blog nicht so fühlen, als würden sie bei der Arbeit mit ihrem Blog ein Dienstprogramm eines Drittanbieters verwenden. Stattdessen arbeiten sie mit einer Verbesserung (im Gegensatz zu einer Ergänzung) der Kernplattform.

Zwar ist die Verwendung nativer WordPress-Stile kein echter Teil der Einstellungs-API, und das obige ist eine eher subjektive Perspektive, aber Aspekte der Einstellungs-API - wie das Einführen von Menüseiten - nutzen native WordPress-Stile. Ist es nicht sinnvoll, dass sich der Rest Ihrer Arbeit anpasst??

Sicherer, widerstandsfähiger

Indem Sie Funktionen nutzen, die in WordPress integriert sind, anstatt Ihre eigenen zu nutzen, können Sie sicher sein, dass das Speichern, Abrufen und Überprüfen der Einstellungen ordnungsgemäß verwaltet wird. Schließlich bietet die Einstellungs-API weitgehend die gleiche Funktionalität, auf die sich die Kernanwendung stützt.

Darüber hinaus unterliegt die Einstellungs-API den gleichen Regeln wie der Rest der WordPress-API. Wenn also die Anwendung aktualisiert wird und / oder Änderungen vorgenommen werden, müssen die Funktionen den üblichen Verfallsvorgang durchlaufen. Dadurch haben Sie ausreichend Zeit, um an der Aktualisierung Ihres Projekts zu arbeiten, bevor die Kompatibilität abbricht. Dies ist nicht unbedingt der Fall, wenn Sie Ihre eigenen Funktionen nutzen möchten.

Anstehende Roadmap

An diesem Punkt sollten Sie ein klares Verständnis dafür haben, was die Einstellungs-API ist und warum Sie sie in der Design- und Plugin-Arbeit verwenden sollten.

Natürlich ist das alles ein bisschen umstritten - wir haben uns bisher noch keine praktischen Beispiele angesehen. In dieser Serie werfen wir einen Blick auf Folgendes:

  • Menüs, Abschnitte und Registernavigation
  • Abschnittseinstellungen registrieren
  • Grundelemente (Eingänge, Textbereiche, Auswahlfelder, Optionsfelder und Kontrollkästchen)
  • Ein einfaches Arbeitsbeispiel

Am Ende der Serie sollten Sie über alles verfügen, um solide auf WordPress basierende Produkte zu erstellen.