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
220
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
850
How better performing websites can help save the planet
jacklenox
0
1.6k
What WordPress developers can do about climate change
jacklenox
0
220
An Introduction to Object-Oriented Programming, Design Patterns, and Test-Driven Development
jacklenox
3
450
Building Websites with the REST API
jacklenox
0
290
There and Back Again: A Developer's Tale
jacklenox
3
1.8k
Writing PHP with React
jacklenox
0
400
Theming, React and the REST API
jacklenox
0
510
Building themes with the WP REST API
jacklenox
1
750
Other Decks in Technology
See All in Technology
SpannerとAurora DSQLの同時実行制御の違いに想いを馳せる
masakikato5
0
570
新卒エンジニア研修の試行錯誤と工夫/nikkei-tech-talk-31
nishiuma
0
200
Amazon GuardDuty Malware Protection for Amazon S3を使おう
ryder472
2
110
Keynote - KCD Brazil - Platform Engineering on K8s (portuguese)
salaboy
0
130
Restarting_SRE_Road_to_SRENext_.pdf
_awache
0
170
お問い合わせ対応の改善取り組みとその進め方
masartz
1
410
Go製のマイグレーションツールの git-schemalex の紹介と運用方法
shinnosuke_kishida
1
420
セマンティックレイヤー入門
ikkimiyazaki
9
3.3k
LINEギフトのLINEミニアプリアクセシビリティ改善事例
lycorptech_jp
PRO
0
290
大規模アジャイル開発のリアル!コミュニケーション×進捗管理×高品質
findy_eventslides
0
590
Javaの新しめの機能を知ったかぶれるようになる話 #kanjava
irof
3
4.9k
Riverpod & Riverpod Generatorを利用して状態管理部分の処理を書き換えてみる簡単な事例紹介
fumiyasac0921
0
110
Featured
See All Featured
Statistics for Hackers
jakevdp
798
220k
10 Git Anti Patterns You Should be Aware of
lemiorhan
PRO
656
60k
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
12
620
Music & Morning Musume
bryan
46
6.4k
Speed Design
sergeychernyshev
28
870
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
40
2k
The Pragmatic Product Professional
lauravandoore
33
6.5k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
7
620
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
30
1.1k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
28
1.6k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
tammyeverts
51
2.4k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
507
140k
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/