Eine Einführung in die WordPress REST API

Als die REST API schließlich in den WordPress-Kern aufgenommen wurde, war es das Ende einer langen Reise. Viele hatten diese Änderung als den größten Schritt nach vorne für WordPress in der Geschichte der Plattform erwartet. Wenn Sie jedoch nicht mit der REST API vertraut sind, könnten Sie verwirrt sein, was das alles bedeutet.

Kurz gesagt, die Ergänzung der WordPress REST API verwandelte WordPress in ein vollwertiges Anwendungsframework. Dies erhöhte deutlich seine ‚Erweiterbarkeit‘ oder die Fähigkeit, mit neuen Funktionen und Fähigkeiten erweitert zu werden. Außerdem erweiterte es das Potenzial der Plattform, mit anderen Websites und Anwendungen zu kommunizieren.

Eine Einführung in REST-APIs

Bevor wir tiefer in die WordPress REST API eintauchen, ist es wichtig, unsere Terminologie zu klären. Dies ist ein Thema, bei dem wir viele Abkürzungen verwenden müssen, also lassen Sie uns diese zuerst klären.

Zuerst müssen Sie wissen, was Application Programming Interfaces (APIs) sind. In einfachsten Begriffen ist eine API ein Mittel, durch das ein System anderen Systemen ermöglicht, sich mit seinen Daten zu verbinden.

Zum Beispiel, wenn eine Website einen Facebook „Gefällt mir“-Button zu einer Seite hinzufügt, macht sie das, indem sie sich in die Facebook-API einklinkt. Dies ermöglicht der Webseite, die API zu nutzen, um Daten zu empfangen (den Code für den Gefällt-mir-Button) und Daten zu senden (die Gefällt-mir-Anfrage).

Also, was ist speziell eine REST-API? Representational State Transfer (REST) ist eine Art von API, die spezifisch für Webdienste ist. Sie enthält einen standardisierten Satz von Anweisungen und Regeln, was es einfacher macht, dass alle ‘RESTful’ Dienste miteinander verbinden können.

Kurz gesagt, REST APIs ermöglichen es Ihnen, Anfragen an ein externes System zu stellen. Ein Beispiel dafür ist Twitter. Sie können dessen API verwenden, um eine bestimmte Anzahl von Tweets von einem spezifischen Benutzer anzufordern. Die API wird dann die Tweets basierend auf Ihrer Anfrage zurückgeben, die Sie mittels HTML und CSS auf Ihrer Website einbetten können.

Diese Anfragen werden mit JavaScript Object Notation (JSON) durchgeführt. Dies ist eine speziell für das Senden, Empfangen und Speichern von Daten entwickelte Sprache.

Wir werden JSON später in diesem Artikel behandeln, aber wir empfehlen, sich im Voraus mit dieser Sprache vertraut zu machen. Dies wird Ihnen helfen, sich auf die Nutzung der WordPress REST API vorzubereiten und einige der Konzepte zu verstehen, über die wir sprechen werden.

Was die WordPress REST API ist (und warum sie wichtig ist)

Die WordPress REST API funktioniert weitgehend genauso wie die Beispiele, die wir bereits angesprochen haben. Im Grunde gibt Ihnen die WordPress REST API vollen Zugriff auf WordPress-Funktionen von jedem JSON-kompatiblen Framework.

Ähnlich wie die API von Twitter es Ihnen ermöglicht, Tweets abzurufen und zu senden, kann die WordPress REST API verwendet werden, um Beiträge, Benutzer, Kategorien und vieles mehr von externen Plattformen aus zu verwalten. Sie ermöglicht die Nutzung von WordPress auf bisher unerreichte Weisen.

Die REST API wurde bereits 2013 angekündigt. Sie begann als Plugin, das in das WordPress-Kernsystem mit der Version 4.1 integriert werden sollte. Wie so oft kam es zu Verzögerungen, und die Veröffentlichung wurde verschoben, bis sie schließlich drei Jahre später mit der Veröffentlichung von WordPress 4.7 in den Kern implementiert wurde.

Dies war eine lange, aber lohnende Wartezeit für viele Menschen, die die WordPress REST API als einen wichtigen Schritt nach vorne für die Plattform sahen. Sie fragen sich vielleicht, warum diese Ergänzung so eine große Sache war, besonders da viele Benutzer wahrscheinlich keinen großen Unterschied bemerkt haben. Wie sich herausstellt, war die Aufnahme der REST API eine grundlegende Änderung für WordPress aus vielen Gründen.

Durch die Implementierung einer REST API hat sich WordPress von einer reinen Plattform zur Erstellung von Websites entfernt. Stattdessen ist es nun zu einem vollwertigen Anwendungsframework geworden. Das bedeutet, dass Entwickler eine WordPress-Website verwenden können, um Anwendungen für mobile Geräte und das Web zu erstellen oder als Informationsrepository zu nutzen.

Diese Verschiebung ermöglichte es auch WordPress, sich von seiner Abhängigkeit von PHP zu lösen. Indem WordPress mit jeder JSON-kompatiblen Sprache kompatibel gemacht wurde, erweiterte die REST API die Möglichkeiten für Entwickler erheblich, indem sie ihnen ermöglichte, WordPress-Funktionalitäten mit praktisch jedem Framework zu nutzen.

Schließlich bietet die REST API eine erhöhte Flexibilität mit den Schnittstellen, die Sie zur Arbeit mit der Plattform verwenden können. Sie machte die Admin-Oberfläche vollständig optional, da Sie nun ausschließlich über JSON-Befehle mit Ihrer WordPress-Site interagieren können.

Jetzt sehen wir uns an, wie JSON und die REST API zusammenkommen, um dies zu ermöglichen.

Wie die REST-API und JSON zusammenarbeiten

Bis jetzt sollten Sie die theoretischen Aspekte der WordPress REST API verstanden haben. Schauen wir uns also die praktische Seite der Technologie an. Das offizielle Handbuch beschreibt die Verwendung der REST API wie folgt:

„Die WordPress REST API bietet API-Endpunkte für WordPress-Datentypen, die es Entwicklern ermöglichen, aus der Ferne mit Websites zu interagieren, indem sie JSON (JavaScript Object Notation)-Objekte senden und empfangen.“

Das erste Wort, auf das wir uns hier konzentrieren müssen, ist „endpoints“. Die einfachste Art, sich einen Endpoint vorzustellen, ist als ein Stück Daten oder eine Funktion, die mittels einer JSON-Anfrage aufgerufen werden kann. Standardmäßig bietet WordPress eine große Anzahl von standardmäßigen Endpoints zur Verwendung an, aber Entwickler können auch benutzerdefinierte Endpoints erstellen.

Um einen Endpunkt zu erreichen, müssen Sie eine ‘Route’ verwenden, die die Form einer normalen URL hat. Sie können dies sogar jetzt sofort selbst ausprobieren.

Gehen Sie zu Ihrer eigenen WordPress-Seite und fügen Sie /wp-json/wp/v2 am Ende der URL hinzu. Wenn Ihre Seite http://example.com ist, würden Sie http://example.com/wp-json/wp/v2 eingeben.

Wenn Sie diese Route laden, erreichen Sie den Endpunkt, der in diesem Fall alle Inhalte und Meta-Daten für Ihre Website in einem (unordentlichen) JSON-Format zurückgibt. Durch die Verwendung verschiedener Routen können Sie auf unterschiedliche Endpunkte zugreifen, um spezifische Informationen zu erhalten und verschiedene Aufgaben auszuführen.

Es gibt drei primäre JSON-Anfragen, die Sie mit der REST API verwenden werden, also werfen wir jetzt auch schnell einen Blick darauf. Sie sind:

• GET. Diese Art der Anfrage wird verwendet, um Daten von der API abzurufen und aufzulisten. Beispielsweise würden Sie eine GET-Anfrage verwenden, um eine Liste von Benutzern auf Ihrer Website zurückzugeben oder Blog-Beiträge aus einem bestimmten Zeitraum zu kompilieren.
• POST. Diese Anfrage wird verwendet, um Daten an die API zu senden. Sie ermöglicht es Ihnen, neue Informationen an WordPress zu übermitteln, wie das Hinzufügen neuer Benutzer und Beiträge oder das Aktualisieren bestehender Daten.
• DELETE. Wie der Name schon sagt, wird diese Anfrage verwendet, um Daten zu löschen. Dies ermöglicht es Ihnen, Beiträge, Seiten, Benutzer und mehr zu entfernen.

GET und POST können manchmal mit demselben Endpunkt verwendet werden, um unterschiedliche Ergebnisse zu erzielen.

Zum Beispiel betrachten wir den Endpunkt /me/settings/. Wenn Sie eine GET-Anfrage an diesem Endpunkt durchführen würden, erhielten Sie eine Liste der aktuellen Einstellungen des Benutzers. Jedoch könnten Sie durch die Verwendung einer POST-Anfrage an demselben Endpunkt die Einstellungen stattdessen aktualisieren.

Erste Schritte mit der WordPress REST API

Wir werden nun all diese Theorie in die Praxis umsetzen und Ihnen einige sehr grundlegende Beispiele zeigen, was Sie mit der REST API machen können. Dies ist nur ein Vorgeschmack, um Ihnen zu helfen, sich mit der Nutzung der REST API zur Verarbeitung von Anfragen an WordPress vertraut zu machen.

Für weitere Beispiele empfehlen wir, die offizielle Referenzbibliothek und die REST API Ressourcen zu überprüfen.

Die folgenden Techniken erfordern die Verwendung der Befehlszeile, um JSON-Anfragen zu verarbeiten. Dies ermöglicht es Ihnen, mit Ihrer WordPress-Seite über eine textbasierte Schnittstelle zu interagieren und einfache Befehle zu senden.

Wenn Sie keine Erfahrung mit der Befehlszeile haben, empfehlen wir Ihnen, sich zunächst etwas Zeit zu nehmen, um die Grundlagen zu erlernen. Sie möchten vielleicht auch SSH verwenden, um die Verbindung mit Ihrer Website herzustellen.

Schließlich, wenn Sie bereit sind, schauen wir uns einige Beispiele an, wie Sie die WordPress REST API nutzen können!

1. Beiträge von einer Webseite zurückgeben

Obwohl Sie natürlich die richtige Berechtigung benötigen, um eine Website zu bearbeiten, ist es möglich, einige Informationen von fast jeder WordPress-Website abzurufen. Dies liegt daran, dass die REST API bei allen WordPress-Installationen gleich ist.

Wie wir besprochen haben, besteht der Hauptgrund dafür, dass APIs existieren, darin, externen Anwendungen den Zugriff auf einige Ihrer Daten zu ermöglichen. In diesem Beispiel können wir einen einzelnen Beitrag aus dem offiziellen WordPress-News-Blog abrufen:

curl https://wordpress.org/news/wp-json/wp/v2/posts/1

Die ID wurde auf 1 festgelegt, was bedeutet, dass diese Anforderung den allerersten Beitrag im Blog abruft. Es könnte schwer zu erkennen sein, da das JSON nicht sehr lesbar ist, aber unter dem Code können Sie alle Inhalte und Meta-Daten für den Beitrag erkennen:

Sie könnten dann diese Informationen in einer Anwendung verwenden, beispielsweise, um sie mit Ihrem eigenen angepassten Styling anzuzeigen.

Wenn Sie stattdessen alle Beiträge des Blogs zurückgeben möchten, müssen Sie lediglich die ID am Ende entfernen. Es ist jedoch wahrscheinlicher, dass Sie eine ausgewählte Anzahl von Beiträgen zurückgeben möchten. Die folgende Anfrage wird die letzten drei Beiträge zurückgeben:

curl https://wordpress.org/news/wp-json/wp/v2/posts/?per_page=3

Sie können dies selbst mit anderen Websites und sogar Ihrem eigenen Blog ausprobieren.

2. Einen Beitrag aktualisieren

Jetzt versuchen wir, einige Änderungen an WordPress mit der REST API vorzunehmen. Dazu müssen Sie auf der Seite angemeldet sein, die Sie verwalten möchten. Wenn Sie zum Beispiel SSH verwenden, müssen Sie sich bei Ihrem Server anmelden.

In diesem Beispiel werden wir einen bestehenden Beitrag aktualisieren. Zuerst verwenden wir eine Anfrage, um den Titel des Beitrags mit der ID 1 zu aktualisieren:

curl -X POST http://example.com/wp-json/wp/v2/posts/1 -d '{"title":"A Brand New Title"}'

Dies ist ziemlich selbsterklärend. Das Titelargument zeigt, dass Sie den Titel des Beitrags aktualisieren, gefolgt von der Textzeichenfolge, die den Ersatz enthält.

Es gibt zahlreiche andere Argumente, die Sie verwenden können, um Änderungen an einem Beitrag vorzunehmen. Beispielsweise können Sie eine Liste verwenden, um Kategorien dem Beitrag zuzuweisen, ihn zu veröffentlichen oder seinen Inhalt vollständig zu ändern.

3. Einen Benutzer löschen

Schließlich werfen wir einen Blick darauf, wie Sie Daten über die REST API entfernen können. In diesem Beispiel werden wir einen Benutzer von der Website entfernen. Natürlich müssen Sie eingeloggt und autorisiert sein, um Benutzer verwalten zu können, bevor Sie diese Funktion nutzen können.

Dann können Sie die folgende Anfrage verwenden, um den Benutzer mit der ID 101 zu löschen:

curl -X DELETE http://example.com/wp-json/wp/v2/users/101

Dies wird den angegebenen Benutzer von der Website entfernen. Sie können die zusätzlichen Parameter verwenden, um die Beiträge des Benutzers basierend auf deren ID einem anderen Benutzer zuzuweisen. Alternativ können Sie eine dauerhafte Löschung erzwingen, anstatt den Benutzer in den Papierkorb zu versetzen.

Anhand dieser Beispiele können Sie beginnen zu verstehen, wie die REST API Ihnen ermöglicht, den Inhalt auf Ihrer Website zu verwalten und eine Verbindung zu anderen herzustellen. Wenn Sie mehr erfahren möchten, empfehlen wir Ihnen, tiefer in das REST API Handbuch einzutauchen.

WordPress-Entwicklung erkunden

Die WordPress REST API war ein großer Schritt nach vorne für die Plattform, weg von ihren Wurzeln und in die Zukunft. Entwickler waren vom ersten Tag an begeistert, aber wenn Sie nicht von Anfang an mit REST APIs vertraut waren, könnten Sie verwirrt gewesen sein, warum.

Obwohl die REST API für Anfänger überwältigend erscheinen mag, müssen Sie kein erfahrener Entwickler sein, um einige grundlegende Anfragen zu verwenden. Zum Beispiel ermöglicht Ihnen die API, verschiedene Aufgaben auf Ihrer eigenen Website (oder anderen) durchzuführen, wie das Zurückgeben von Beiträgen, das Aktualisieren von Beiträgen und das Löschen von Benutzern.

Suchen Sie nach leistungsstarkem Hosting für Ihre WordPress-Website? Bei Dreamhost bieten unsere DreamPress verwalteten Pläne professionelle Staging-Umgebungen, automatische Backups, integrierte Caching und mehr. Schauen Sie sich heute unsere Pläne an!