WordPress REST-API: Wie Du sie für die Entwicklung nutzt

Inhaltsverzeichnis

WordPress REST-API: Wie Du sie für die Entwicklung nutzt

WordPress ist längst mehr als nur ein Content-Management-System (CMS) für Blogs. Dank der REST-API hat sich WordPress zu einer vollwertigen Plattform für die Entwicklung von Web- und Mobile-Anwendungen gewandelt. Aber was ist die WordPress REST-API, und wie kannst Du sie für Deine Projekte nutzen? In diesem Artikel erkläre ich Dir alles Wichtige: von den Grundlagen bis hin zu praktischen Anwendungsszenarien.


Was ist die WordPress REST-API?

Die WordPress REST-API ist eine Programmierschnittstelle, die es ermöglicht, mit WordPress-Daten (z. B. Beiträgen, Seiten, Benutzern oder Medien) über HTTP-Anfragen zu interagieren. Das bedeutet, Du kannst WordPress-Daten auslesen, erstellen, aktualisieren und löschen – und das alles über einfache HTTP-Methoden wie GET, POST, PUT und DELETE.

Vorteile der WordPress REST-API:

  1. Plattformunabhängigkeit: Du kannst Daten in einer beliebigen Sprache oder Umgebung abrufen, die HTTP-Anfragen unterstützt.
  2. Entkopplung von Frontend und Backend: Mit der REST-API kannst Du WordPress als Backend nutzen und ein völlig unabhängiges Frontend entwickeln – zum Beispiel mit React, Vue.js oder sogar einer mobilen App.
  3. Flexibilität: Du kannst maßgeschneiderte APIs erstellen, die genau die Daten bereitstellen, die Du benötigst.

Erste Schritte mit der WordPress REST-API

Bevor wir in die technischen Details eintauchen, solltest Du sicherstellen, dass die REST-API in Deiner WordPress-Installation verfügbar ist. Seit WordPress 4.7 ist die REST-API standardmäßig integriert.

Anforderungen:

  • Eine aktuelle WordPress-Version (mindestens 4.7).
  • Aktivierte Permalinks in den WordPress-Einstellungen (notwendig, um „saubere“ API-Endpunkte zu nutzen).

Basis-URL der REST-API

Die REST-API ist standardmäßig unter folgender URL erreichbar:

arduino
https://deine-domain.com/wp-json/wp/v2/

Hier ist /wp-json/ das Standard-API-Präfix, und /wp/v2/ bezeichnet die Version der API.


Die Grundlagen der WordPress REST-API

Die REST-API nutzt die folgenden HTTP-Methoden, um Aktionen auszuführen:

  • GET: Daten auslesen (z. B. Beiträge abrufen).
  • POST: Neue Daten erstellen (z. B. einen neuen Beitrag veröffentlichen).
  • PUT/PATCH: Bestehende Daten aktualisieren.
  • DELETE: Daten löschen.

Lass uns diese Methoden anhand eines praktischen Beispiels betrachten.

Beispiel 1: Beiträge abrufen

Du kannst Beiträge über eine einfache GET-Anfrage abrufen:

bash
https://deine-domain.com/wp-json/wp/v2/posts

Die Antwort ist ein JSON-Objekt, das eine Liste von Beiträgen enthält. Ein typischer API-Response könnte so aussehen:

json
[
{
"id": 1,
"title": {
"rendered": "Mein erster Beitrag"
},
"content": {
"rendered": "<p>Das ist der Inhalt des Beitrags.</p>"
}
},
{
"id": 2,
"title": {
"rendered": "Ein weiterer Beitrag"
}
}
]

Beispiel 2: Einen Beitrag erstellen

Um einen neuen Beitrag zu erstellen, sendest Du eine POST-Anfrage an denselben Endpunkt. Dafür benötigst Du eine Authentifizierung, da das Erstellen von Beiträgen nicht öffentlich zugänglich ist (dazu später mehr). Die Anfrage könnte so aussehen:

json
POST https://deine-domain.com/wp-json/wp/v2/posts
Headers:
Authorization: Bearer {Dein-Token}
Body:
{
"title": "Neuer Beitrag",
"content": "Das ist der Inhalt meines neuen Beitrags",
"status": "publish"
}

Authentifizierung in der WordPress REST-API

Die meisten Aktionen in der REST-API erfordern eine Authentifizierung, insbesondere wenn Du Daten erstellen, aktualisieren oder löschen möchtest. Es gibt mehrere Authentifizierungsmethoden:

1. Cookie-basierte Authentifizierung

Diese Methode wird oft verwendet, wenn Du direkt in einem WordPress-Frontend arbeitest. Benutzer müssen eingeloggt sein, um authentifiziert zu werden.

2. Basic Auth

Für Entwicklungs- und Testzwecke kannst Du das Plugin „Basic Auth“ verwenden. Damit kannst Du Benutzername und Passwort direkt in der Anfrage übermitteln, was allerdings unsicher ist und nicht in der Produktion verwendet werden sollte.

Beispiel:

bash
curl --user benutzername:passwort https://deine-domain.com/wp-json/wp/v2/posts

3. JWT (JSON Web Token) Auth

JWT ist eine sichere und beliebte Methode zur Authentifizierung. Dazu musst Du ein Plugin wie „JWT Authentication for WP REST API“ installieren. Nach der Einrichtung erhältst Du ein Token, das Du in den Header der Anfrage einfügst:

bash
Authorization: Bearer {Dein-Token}

Erweiterung der WordPress REST-API

Die WordPress REST-API ist flexibel und lässt sich leicht erweitern. Du kannst eigene Endpunkte hinzufügen oder die vorhandenen Endpunkte anpassen.

Eigene Endpunkte erstellen

Hier ein einfaches Beispiel, wie Du einen eigenen Endpunkt hinzufügen kannst, der eine Liste von Kategorien ausgibt:

php
add_action('rest_api_init', function () {
register_rest_route('custom/v1', '/categories', array(
'methods' => 'GET',
'callback' => 'get_custom_categories',
));
});
function get_custom_categories() {
$categories = get_categories();
return rest_ensure_response($categories);
}

Nach dem Hinzufügen dieses Codes (zum Beispiel in die functions.php Deines Themes) ist der neue Endpunkt unter https://deine-domain.com/wp-json/custom/v1/categories verfügbar.


Nutzungsszenarien der WordPress REST-API

Die REST-API eröffnet Dir eine Vielzahl von Anwendungsmöglichkeiten. Hier sind einige gängige Szenarien:

1. Headless WordPress

Du kannst WordPress als Backend verwenden und ein komplett unabhängiges Frontend mit React, Vue.js oder Angular entwickeln. Die REST-API liefert die Daten, die das Frontend benötigt, in Echtzeit.

2. Mobile Apps

Mit der REST-API kannst Du mobile Apps entwickeln, die Daten aus Deinem WordPress-Blog abrufen oder Inhalte erstellen. Zum Beispiel könnte eine App die neuesten Beiträge anzeigen und es Nutzern ermöglichen, Kommentare zu hinterlassen.

3. Datenintegration

Wenn Du Daten aus WordPress in ein anderes System integrieren möchtest (z. B. ein CRM oder eine E-Commerce-Plattform), kannst Du die REST-API nutzen, um nahtlos Informationen auszutauschen.

4. Eigene Dashboards

Erstelle maßgeschneiderte Dashboards für Deine Kunden oder Mitarbeiter, indem Du Daten aus WordPress über die REST-API abrufst und in einer benutzerfreundlichen Oberfläche darstellst.


Tipps für die Entwicklung mit der WordPress REST-API

  1. Verwende Filter: Die REST-API unterstützt viele Filterparameter, wie ?per_page=10 oder ?orderby=title. Nutze sie, um gezielt Daten abzurufen.
  2. Caching: API-Anfragen können serverseitig oder clientseitig gecacht werden, um die Performance zu verbessern.
  3. Dokumentation nutzen: Die offizielle WordPress REST-API-Dokumentation ist eine hervorragende Ressource, um alle verfügbaren Endpunkte und Funktionen zu verstehen.

Fazit

Die WordPress REST-API ist ein mächtiges Werkzeug, das weit über die klassische Verwendung von WordPress als CMS hinausgeht. Sie ermöglicht es Dir, flexible und skalierbare Anwendungen zu entwickeln, die WordPress-Daten nahtlos integrieren. Egal, ob Du ein Headless-Frontend, eine mobile App oder eine benutzerdefinierte Datenintegration planst – die REST-API bietet Dir die Werkzeuge, die Du benötigst. Probiere sie aus, und entdecke die nahezu unbegrenzten Möglichkeiten!

Frage zum Artikel?
Leistungen
WordPress Webdesign
Professionelles Webdesign zum Festpreis.
WordPress SEO
Individuelle SEO-Strategie für Ihre WordPress Website.
Alle Lesitungen
Übersicht aller angebotenen Dienstleistungen.
Warenkorb
Nach oben scrollen