Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
An introduction to the WordPress REST API
Search
Jack Lenox
November 19, 2016
Technology
1
230
An introduction to the WordPress REST API
Presented at WordCamp Athens 2016.
Created using Marp:
https://yhatt.github.io/marp/
Jack Lenox
November 19, 2016
Tweet
Share
More Decks by Jack Lenox
See All by Jack Lenox
How better performing websites can help save the planet
jacklenox
3
900
How better performing websites can help save the planet
jacklenox
0
1.7k
What WordPress developers can do about climate change
jacklenox
0
230
An Introduction to Object-Oriented Programming, Design Patterns, and Test-Driven Development
jacklenox
3
460
Building Websites with the REST API
jacklenox
0
310
There and Back Again: A Developer's Tale
jacklenox
3
1.9k
Writing PHP with React
jacklenox
0
420
Theming, React and the REST API
jacklenox
0
520
Building themes with the WP REST API
jacklenox
1
780
Other Decks in Technology
See All in Technology
Microsoft Clarityでインサイトを見つけよう
nakasho
0
100
Tableau API連携の罠!?脱スプシを夢見たはずが、逆に依存を深めた話
cuebic9bic
2
180
TypeScript 上達の道
ysknsid25
23
5.1k
生成AI時代におけるAI・機械学習技術を用いたプロダクト開発の深化と進化 #BetAIDay
layerx
PRO
1
550
[TechNight #91] Oracle Database 最新パフォーマンス分析手法
oracle4engineer
PRO
4
310
Perlアプリケーションで トレースを実装するまでの 工夫と苦労話
masayoshi
1
310
金融サービスにおける高速な価値提供とAIの役割 #BetAIDay
layerx
PRO
1
400
風が吹けばWHOISが使えなくなる~なぜWHOIS・RDAPはサーバー証明書のメール認証に使えなくなったのか~
orangemorishita
13
4.4k
少人数でも回る! DevinとPlaybookで支える運用改善
ishikawa_pro
5
2k
解消したはずが…技術と人間のエラーが交錯する恐怖体験
lamaglama39
0
150
【Λ(らむだ)】最近のアプデ情報 / RPALT20250729
lambda
0
200
Power Automate のパフォーマンス改善レシピ / Power Automate Performance Improvement Recipes
karamem0
0
280
Featured
See All Featured
Optimizing for Happiness
mojombo
379
70k
A Modern Web Designer's Workflow
chriscoyier
695
190k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
367
26k
Product Roadmaps are Hard
iamctodd
PRO
54
11k
Designing Experiences People Love
moore
142
24k
Balancing Empowerment & Direction
lara
1
510
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
addyosmani
7
770
Side Projects
sachag
455
43k
Being A Developer After 40
akosma
90
590k
Testing 201, or: Great Expectations
jmmastey
44
7.6k
The Art of Delivering Value - GDevCon NA Keynote
reverentgeek
15
1.6k
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
marktimemedia
31
2.4k
Transcript
An introduc on to the WordPress REST API Jack Lenox
(@jacklenox) WordCamp Athens 2016
I Greece!
1. The case for a WordPress REST API
What is a REST API?
It stands for REpresenta onal State Transfer Applica on Programming
Interface
Centred around verbs GET POST UPDATE PUT DELETE etc. Different
ways to interact with your data
Usually responds in XML or JSON format XML (Extensible Markup
Language) HTML RSS JSON (JavaScript Object Notation)
Why does WordPress need one?
None
MoMA in New York (c. 2009) Their developers wanted to
use: WordPress as the CMS Ruby to build the front-end
Why? I don't know... but they did
None
WordPress.com API Released in 2012 Available to self-hosted sites via
Jetpack Powerful and road-tested Not extensible (unless you work at Automa c!)
None
REST API use cases Non-PHP implementations Mobile devices But most
recently...
JavaScript OMGBBQ!
None
Internet of things
So, what is the WordPress REST API?
None
None
Merge meline WordPress 4.4 (8 December 2015) Infrastructure merged No
endpoints WordPress 4.7 (due 6 December 2016) Endpoints merged!
2. How the WordPress REST API works (aka, what the
heck is an endpoint?)
End‐what? REST APIs interprets a URL, and return a response
Not wildly different to RSS Sample request to fetch some posts: wc-athens.dev/wp-json/wp/v2/posts
[ { "id": 1, "date": "2016-11-18T14:08:53", "date_gmt": "2016-11-18T14:08:53", "modified": "2016-11-18T14:08:53",
"modified_gmt": "2016-11-18T14:08:53", "slug": "hello-world", "type": "post", "link": "http://wp-rest-api-demo.dev/2016/11/18/hello-wor "title": { "rendered": "Hello world!" }, "content": { "rendered": "<p>Welcome to WordPress. This is your fi "protected": false } } ]
More endpoints... Single post: wc-athens.dev/wp-json/wp/v2/posts/1 All pages: wc-athens.dev/wp-json/wp/v2/pages All users:
wc-athens.dev/wp-json/wp/v2/users All categories: wc-athens.dev/wp-json/wp/v2/categories
Moar verbs! By default, our calls to the REST API
are GET requests. But we can do a lot more: POST PUT UPDATE DELETE
Authen ca on!
A few ways to authen cate Basic Authen ca on
Quick and dirty Cookie Authen ca on Good, especially for themes and plugins OAuth 1.0 A bit complicated, but versatile OAuth 2 Less complicated than OAuth 1, but requires HTTPS
Brokered Authen ca on The broker apps.wp-api.org Otherwise, it's OAuth
1.0
Modifying endpoints
3. Uses for the WordPress REST API
Custom wp‐admin interfaces Calypso developer.wordpress.com/calypso/ Happytables www.happytables.com
Mobile applica ons WordPress apps for iOS and Android apps.wordpress.com/mobile/
Vienna github.com/joehoyle/vienna
Themes Picard github.com/automattic/picard/ Anadama github.com/ryelle/anadama-react/ Foxhound github.com/ryelle/foxhound/
Plugins WooCommerce github.com/woocommerce/woocommerce EDD github.com/easydigitaldownloads/Easy-Digital- Downloads Syndication?
Enterprise Quartz qz.com Facebook facebookbrand.com Google IO (not WordPress, but...)
events.google.com/io2016/
Very exci ng mes ahead!
Further reading, and any ques ons? The WordPress REST API
docs v2.wp-api.org WordPress TV wordpress.tv (search "REST API") javascriptforwp.com
Ευχαριστώ πολύ! @jacklenox We're hiring! automa c.com/work‐with‐us/