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
200
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
680
How better performing websites can help save the planet
jacklenox
0
1.4k
What WordPress developers can do about climate change
jacklenox
0
130
An Introduction to Object-Oriented Programming, Design Patterns, and Test-Driven Development
jacklenox
3
440
Building Websites with the REST API
jacklenox
0
250
There and Back Again: A Developer's Tale
jacklenox
3
1.7k
Writing PHP with React
jacklenox
0
370
Theming, React and the REST API
jacklenox
0
490
Building themes with the WP REST API
jacklenox
1
660
Other Decks in Technology
See All in Technology
Documentação de Produtos: Artefatos essenciais na prática
rigolon
1
190
Babylon.js JAPAN活動紹介 (2024/4)
limes2018
1
120
Building Dashboards as a Hobby
egmc
0
410
EM完全に理解した と思ったけど、 やっぱり何も分からなかった話 / EM Night Fukuoka #1
hirutas
0
300
KubeConにproposalを送りたい人へのアドバイス
sat
PRO
3
280
M5stackで使用できるpHセンサの開発
shinrinakamura
0
260
Max out Local LLM in Challenging Environments
sashimimochi
2
200
CockroachDB はどのくらい「しぶとい」のか? / How tough is CockroachDB?
kota2and3kan
4
970
One engineer company with Ruby on Rails
rstankov
2
450
リテール金融(キャッシュレス・ネット銀行・ネット証券)の競争環境と経済圏
8maki
0
1.7k
LangSmith入門―トレース/評価/プロンプト管理などを担うLLMアプリ開発プラットフォーム
os1ma
5
770
Cracking the KubeCon CfP
inductor
2
270
Featured
See All Featured
Design by the Numbers
sachag
274
18k
ReactJS: Keep Simple. Everything can be a component!
pedronauck
660
120k
Happy Clients
brianwarren
92
6.4k
Building Your Own Lightsaber
phodgson
100
5.7k
Large-scale JavaScript Application Architecture
addyosmani
504
110k
Build The Right Thing And Hit Your Dates
maggiecrowley
25
2k
Helping Users Find Their Own Way: Creating Modern Search Experiences
danielanewman
21
1.9k
For a Future-Friendly Web
brad_frost
172
9k
Optimizing for Happiness
mojombo
370
69k
Docker and Python
trallard
35
2.7k
Building a Scalable Design System with Sketch
lauravandoore
457
32k
Learning to Love Humans: Emotional Interface Design
aarron
267
39k
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/