WordPress REST API - WordCamp Seattle 2017...olope.me/wcsea17/slides.pdf Matt Perry // @mattoperry ALL ENDPOINTS developer.wordpress.org/rest-api/reference GET/wp-json posts, post

Matt Perry // @mattoperryolope.me/wcsea17/slides.pdf

WordPress REST APIquick intro


the basics extendinguse casesthe future


PART 1

the basics


REST APIrepresentational

state transfer

applicationprogramminginterface


A interface that uses http operations (GET, POST …) to interact with an application.


JSON


language of the REST API

JavaScript Object Notation


PHP REST

functions/classesserver only localpageloadHTML

routes/endpointsclient/server

remoterequest/response

JSON


routea uri that corresponds to an API operation


ROUTE: EXAMPLE

wp-json/wp/v2/posts

basepath

namespace

resource path

version


route + http method = endpoint


/wp-json/wp/v2/posts


FUN FACTS

100s of endpoints

on by default

everywhere! (4.7+)


ENDPOINT EXAMPLES

GET /wp-json/wp/v2/posts?per_page=5&author=1

POST /wp-json/wp/v2/categories

DELETE /wp-json/wp/v2/tags/1

POST /wp-json/wp/v2/categories/5


ALL ENDPOINTS

developer.wordpress.org/rest-api/referenceGET/wp-json

posts, post revisions, categories, tags, pages, comments taxonomies, media, users, post types, post statues, settings


plugin 4.4 4.5 4.6 4.7 4.8 2013 ——————————— — — — — — — — 2016 2016 2017


developer.wordpress.org/rest-api


PART 2

extending


init parse_request

rewrite rules query var

rest_api_loaded()


REST_API_LOADED()

REST ROUTE? —> rest_get_server()

WP_REST_Server serve_request()

WP_REST_Request

dispatch()

WP_REST_Response

rest_api_init


CHANGING BUILT-IN ENDPOINTS

:) add data :( remove data :( modify data



register_meta( $type, $key, $args )








CUSTOM CONTENT TYPES

post, taxonomyhidden by defaultwp namespace


CUSTOM CONTENT TYPES


MAKING BRAND NEW ENDPOINTS

pluginsnamespaces

wp-json/myplugin/v1/…



register_rest_route()

rest_api_init











sanitization/validation/more

WP_REST_Controller https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/#the-controller-pattern


PERMISSIONS AND AUTHENTICATION

permissions_callback

cookie auth / nonces

plugins: OAuth1, basic …


PART 3

use cases


USE CASES


USE CASES

Time Magazine Quartz

Facebook Branding Guggenheim


USE CASES

content networks

wp wp wp wp wp wp

contentstore


USE CASES

native appsimport / exportrealtime appsintegrations


THE FUTURE

WP: “restification”a universal language


NEXT STEPS

learn“restify” your plugin

contribute


Documents

WordPress REST API - WordCamp Seattle 2017...olope.me/wcsea17/slides.pdf Matt Perry // @mattoperry ALL ENDPOINTS developer.wordpress.org/rest-api/reference GET/wp-json posts, post