An Introduction to the WordPress REST API - A presentation given at WordCamp Orange County 2019

2. An introduction to the
WP REST API

3. Hello, I’m John
I am no expert

4. Hello, I’m John
I am no expert

5. OK, let’s dive in

6. Today we’ll cover
- What is the REST API?
- What problem I was trying to solve
- How I would have solved the issue
without the REST API
- How I used the REST API for fun and profit
- Tools I used
- Where to continue your learning

7. Today we’ll cover
- What is the REST API?
- What problem I was trying to solve
- How I would have solved the issue
without the REST API
- How I used the REST API for fun and profit
- Tools I used
- Where to continue your learning

8. Today we’ll cover
- What is the REST API?
- What problem I was trying to solve
- How I would have solved the issue
without the REST API
- How I used the REST API for fun and profit
- Tools I used
- Where to continue your learning

9. Today we’ll cover
- What is the REST API?
- What problem I was trying to solve
- How I would have solved the issue
without the REST API
- How I used the REST API for fun and profit
- Tools I used
- Where to continue your learning

10. Today we’ll cover
- What is the REST API?
- What problem I was trying to solve
- How I would have solved the issue
without the REST API
- How I used the REST API for fun and profit
- Tools I used
- Where to continue your learning

11. Today we’ll cover
- What is the REST API?
- What problem I was trying to solve
- How I would have solved the issue
without the REST API
- How I used the REST API for fun and profit
- Tools I used
- Where to continue your learning

12. What is the REST API?

13. “The WordPress REST API provides API endpoints for
WordPress data types that allow developers to interact
with sites remotely by sending and receiving JSON
(JavaScript Object Notation) objects. This enables
developers to create, read and update WordPress content
from client-side JavaScript or from external applications,
even those written in languages beyond PHP.”
- WordPress

14. REST API Methods
- GET: Retrieve data from server
- POST: Send data to server
- PUT: Change/update data on server
- DELETE: Remove data from server

15. Other REST API Terms
- Routes & Endpoints
- Requests
- Responses
- Schema
- Controller Classes

16. The Problem to Solve

19. How I Would Normally
Solve This Issue

20. Option 1
Shortcode

23. The Challenges w/
The Shortcode

25. Option 2
The Listener

27. The Challenges w/
The Listener

28. WP REST API
to the rescue

29. Step 1
Create a Route

30. REST API
If you’re using pretty permalinks
yoursite.com/wp-json/
If not
yoursite.com/?rest_route=/

31. Posts Endpoint
WordPress has a number of built-in
endpoints you can use. For example:
/wp-json/wp/v2/posts

32. Posts Endpoint
WordPress has a number of built-in
endpoints you can use. For example:
/wp-json/wp/v2/posts/123
https://developer.wordpress.org/rest-api/reference/

34. yoursite.com/wp-json/clientname/v1/datahandler/

35. yoursite.com/wp-json/clientname/v1/datahandler/456

36. Step 2
Callback Function

44. Questions so far?

45. Let’s Talk Tools

46. JSON Formatter
A Chrome Extension to make looking
at JSON content a heck of a lot easier.

47. JSON Formatter

48. JSON Formatter

49. Postman
A Mac/Windows/Unix app for easily
testing your API

50. Postman
A Mac/Windows/Unix app for easily
testing your API

51. Postman

52. Learn more at
https://developer.wordpress.org/rest-api/

53. Any More Questions?

54. Thank You!
If you have any
comments or
followup questions:
john@vegasgeek.com