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
910
How better performing websites can help save the planet
jacklenox
0
1.7k
What WordPress developers can do about climate change
jacklenox
0
240
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
430
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
新卒(ほぼ)専業Kagglerという選択肢
nocchi1
0
1.5k
開発と脆弱性と脆弱性診断についての話
su3158
0
140
[kickflow]20250319_少人数チームでのAutify活用
otouhujej
0
180
僕たちが「開発しやすさ」を求め 模索し続けたアーキテクチャ #アーキテクチャ勉強会_findy
bengo4com
0
2.6k
MySQL HeatWave:サービス概要のご紹介
oracle4engineer
PRO
4
1.6k
LLM時代の検索とコンテキストエンジニアリング
shibuiwilliam
2
910
.NET開発者のためのAzureの概要
tomokusaba
0
150
はじめての転職講座/The Guide of First Career Change
kwappa
5
4.5k
Amazon Inspector コードセキュリティで手軽に実現するシフトレフト
maimyyym
0
150
Cloud WANの基礎から応用~少しだけDeep Dive~
masakiokuda
4
130
いかにして命令の入れ替わりについて心配するのをやめ、メモリモデルを愛するようになったか(改)
nullpo_head
7
2.7k
Gaze-LLE: Gaze Target Estimation via Large-Scale Learned Encoders
kzykmyzw
0
180
Featured
See All Featured
Rails Girls Zürich Keynote
gr2m
95
14k
The Power of CSS Pseudo Elements
geoffreycrofte
77
5.9k
Testing 201, or: Great Expectations
jmmastey
45
7.6k
YesSQL, Process and Tooling at Scale
rocio
173
14k
GraphQLとの向き合い方2022年版
quramy
49
14k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
33
2.4k
Automating Front-end Workflow
addyosmani
1370
200k
Making Projects Easy
brettharned
117
6.3k
Into the Great Unknown - MozCon
thekraken
40
2k
The MySQL Ecosystem @ GitHub 2015
samlambert
251
13k
Intergalactic Javascript Robots from Outer Space
tanoku
272
27k
The Pragmatic Product Professional
lauravandoore
36
6.8k
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/