De WordPress REST API begrijpen: Een gids voor ontwikkelaars

Intro

Het maken van een website is een complex proces dat uit meerdere stappen bestaat. Om te beginnen moet je daarvoor een goede hostingoplossing vinden. Als je een nieuwe website gaat maken en niet veel resources nodig hebt en veel verkeer verwacht, is een VPS-server een veelzijdige oplossing die geschikt is voor de meeste websites. Als de betaalmethode belangrijk voor je is, moet je weten dat je kunt kiezen uit verschillende opties, zoals creditcard VPS, bitcoin VPS, AliPay VPS, enz.

Een ander fundamenteel aspect van het maken van een website is de keuze van een CMS - content management systeem, een speciale tool die wordt gebruikt om de website met inhoud te vullen en aan te passen. Als je WordPress kiest, krijgen je ontwikkelaars te maken met WordPress REST API.

Wordpress is tegenwoordig een van de populairste CMS voor het bouwen van een website. REST API is op zijn beurt een essentiële interface die wordt gebruikt voor het werken met een Wordpress website. Dankzij REST API krijgen je applicaties de mogelijkheid om met je website te communiceren via JSON bestanden. Op deze manier kunnen ontwikkelaars aangepaste toepassingen, websites en plugins bouwen bovenop Wordpress. Met REST API kunnen ontwikkelaars communiceren met Wordpress gegevens door middel van HTTP commando's.

Hieronder bekijken we enkele essentiële commando's die nuttig zijn voor elke ontwikkelaar.

WordPress REST API: Hoofdzaken

GET:

Het wordt gebruikt om gegevens op te halen uit de WordPress database met de HTTP GET methode. Dit commando is een van de meest gebruikte commando's en is het eerste commando dat je gebruikt voordat je daadwerkelijk iets met je gegevens doet.

Hiermee kan een specifieke bron zoals een bericht, pagina of aangepast berichttype worden opgehaald zonder deze te wijzigen.

Om de methode te gebruiken, moet je een verzoek sturen naar een specifiek eindpunt met een gegeven set parameters. Het eindpunt wordt gepresenteerd door een URL van de bron met de parameters die je wilt ophalen - bijvoorbeeld de ID van de bron, filteropties, pagineringinformatie en andere queryparameters.

Als je dit typt:

GET http://yoursite.com/wp-json/wp/v2/posts/983

krijg je de details van het bericht met deze specifieke ID, zoals de titel, inhoud, auteur en andere metagegevens.

Bovendien kun je de informatie over een lijst van bronnen krijgen. Als je bijvoorbeeld alle gepubliceerde bronnen wilt zien, moet je /wp/v2/posts?status=publish toevoegen aan het endpoint verzoek:

GET http://yoursite.com/wp-json/wp/v2/posts?status=publish

POST:

Deze opdracht wordt gebruikt om iets nieuws aan je website toe te voegen. Dit kan eigenlijk een bericht zijn, maar het kan ook worden gebruikt voor pagina's, opmerkingen en andere bijlagen.

Om een nieuwe post te maken, voeg je /wp/v2/posts toe aan het eindpunt.

POST http://yoursite.com/wp-json/wp/v2/posts

Vervolgens kun je in de payload de gegevens voor het nieuwe bericht opnemen, zoals de titel, inhoud, auteur en andere metagegevens:

"title":"Mijn nieuwe bericht", "content":"Dit is de inhoud van mijn nieuwe bericht.", "author": 1, "status": "publish"

PUT:

POST wordt gebruikt om lege concepten voor pagina's en berichten te maken. Om deze verder bij te werken met nieuwe inhoud, kun je de opdracht PUT gebruiken. Dit kan verder worden gebruikt om eerder gemaakte concepten te publiceren.

Om alle huidige concepten te zien, kun je het POST-commando op deze manier gebruiken:

POST http://yoursite.com/wp-json/wp/v2/posts/?status="draft".

Hierna kun je het PUT commando gebruiken om de status van een bepaald concept te wijzigen door de ID ervan in te voeren:

PUT http://yoursite.com/wp-json/wp/v2/posts/983

Hierdoor krijg je toegang tot je bericht met een optie om het te wijzigen. Nu moet je de status wijzigen van "ontwerp" naar "publiceren":

"status" = "publiceren"

Bovendien kun je er meer inhoud aan toevoegen met het argument "status":

"status" = "publiceren" "inhoud" = "inhoud hier"

WISSEN:

Een ander essentieel commando dat wordt gebruikt voor het verwijderen van berichten, pagina's, inhoud en gebruikers. Een verwijderd bericht wordt eerst in de prullenbak geplaatst.

Om een bepaald bericht te verwijderen, bijvoorbeeld het bericht dat hierboven is gemaakt, voer je iets als dit in:

DELETE http://yoursite.com/wp-json/wp/v2/posts/983

Als je het bericht voorgoed wilt verwijderen zonder het naar de prullenbak te sturen, voeg er dan ?force=true achter:

DELETE http://yoursite.com/wp-json/wp/v2/posts/983?force=true

OPTIES:

Als je een bron wilt controleren op de communicatieopties die ervoor beschikbaar zijn, kun je dit commando gebruiken. Als je het commando invoert, krijg je in de uitvoer de lijst met communicatiemethoden die beschikbaar zijn voor een bepaalde bron, samen met wat andere relevante informatie, zoals ondersteunde authenticatieschema's, verzoekheaders en inhoudstypen.

HOOFD:

Met deze opdracht kunnen de headers van de inhoud worden opgehaald zonder dat de inhoud zelf wordt opgehaald. Op deze manier kan een ontwikkelaar de benodigde informatie krijgen over stukken inhoud, zoals caching-informatie, inhoudstype en inhoudslengte, zonder deze te hoeven downloaden.

PATCH:

Met deze opdracht kun je een bepaald deel van een stuk inhoud bijwerken. Het lijkt een beetje op PUT, maar je hoeft een bepaalde bron niet volledig te vervangen. Op deze manier kun je de titel of de inhoud van een bericht bijwerken, evenals metadata die is gekoppeld aan een gebruiker, terwijl de rest hetzelfde blijft.

Als je het commando gebruikt, moet je aangeven welke wijzigingen je wilt doorvoeren. Als je bijvoorbeeld de titel wilt bewerken, moet je dit toevoegen aan de request body:

"Titel": "Nieuwe berichttitel".

Conclusie

WordPress REST API is een multifunctionele interface waarmee je applicaties kunnen communiceren met je WordPress site. De interface wordt beheerd met behulp van verschillende commando's, waaraan we het artikel van vandaag hebben gewijd. We hopen dat deze informatie nuttig was, bedankt voor je tijd!