WordPress APIs

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

WordPress APIs
Feeds, XML-RPC, APP, and “REST”

WordCamp OC - 2012/06/02 - Mike Adams

Hi
• Mike Adams = mdawaffe
• Automattic/WordPress.com: ~6 years
• WordPress developer: ~8 years
• Team Social Lead

Hi
• Mike Adams = mdawaffe
• Automattic/WordPress.com: ~6 years
• WordPress developer: ~8 years
• Team Social Lead
...

WordPress Data
over HTTP
• Feeds
• XML-RPC
• Atom Publishing Protocol
• “REST”

Evaluating
• Provides useful data/ways to manipulate
• Is easy to work with in any language
• Well documented
• Grokkable ...

Feeds
• RSS v. Atom: essentially the same
• Historically, RSS has gotten more love

Feeds: Features
• Get
• Posts, Pages
• Comments
• Can use normal WordPress query args
author_name=mdawaffe,
search=w...

Feeds: Tools
• Command Line: curl
• PHP: SimplePie
http://simplepie.org/

• WordPress: fetch_feed()
Simple wrapper for...

Feeds: Examples
• Via JS, get most recent post titles:
jsﬁddle.net/mdawaffe/ZQn5c/
• Via CLI, get URL of most recent pos...

Feeds: Examples
• Count posts by Marla that contain the
string “movie”.
curl example.com/feed/
?author_name=marla
...

Feeds: Caveats
• Not always a perfect representation of
for-display content
• Never a good representation of
for-edit ...

Feeds: Evaluation
• Data: Posts, Comments Only. Read Only
• Easy: Meh - Libraries
• Docs: Lots of specs
• Grok: Mostly
• C...

Feeds: Conclusion
• Quick way of reading basic data, but caveats
• Longstanding, standard formats
• Parsers available in e...

XML-RPC
• Remote Procedure Call = Function based
• Developed by Dave Winer in 1999
• xmlrpc.scripting.com/spec.html

XML-RPC: Request
POST /xmlrpc.php HTTP/1.1
HOST: example.com
Content-Type: text/xml
Content-Length: 311
<?xml version="1.0...

XML-RPC: Response
HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 27000
<?xml version="1.0"?>
<methodResponse>
<pa...

XML-RPC: WordPress
• WordPress offers considerable
functionality: Read and Write
• Requires Authentication
• Supported o...

XML-RPC: Features
• Get/Create/Edit/Delete
• Posts, Pages
• Comments
• Terms, Taxonomies
• Options
• Media Uploads

XML-RPC: Auth
• All (most) XML-RPC calls require
authentication
• WordPress.ORG
• Username/Password
• Extensible via P...

XML-RPC: Auth
• All (most) XML-RPC calls require
authentication
• WordPress.COM
• Username/Password
• OAuth2

XML-RPC: Docs
• XML-RPC is just a communication spec
• Standard sets of Remote Procedures:
Blogger, MoveableType, MetaWe...

XML-RPC: Extensible
• New Remote Procedures can be added
with the xmlrpc_methods ﬁlter
• Hooked function:
• accepts arr...

XML-RPC: Tools
• Command Line: Hard
• PHP: xmlrpc_encode_request()
• WordPress: WP_HTTP_IXR_Client
• JS: Mimic mimic-xmlrp...

XML-RPC: Example
$x = new WP_HTTP_IXR_Client($URL);
$x->query( ‘wp.newPage’, array(
0, ‘user’, ‘password’,
array(
‘tit...

XML-RPC: Caveats
• Never a true representation of for-display
content
• Usually a true representation of for-edit
cont...

XML-RPC: Evaluation
• Data: Lots of functionality
• Easy: Meh - Libraries
• Docs: No
• Grok: No
• CLI: No

XML-RPC: Conclusion
• Pros
• WordPress offers lots of functionality
• Easy to extend
• Cons
• Caveats
• Verbose XML
•...

APP
• Atom Publishing Protocol
• RESTful - object based
• Posts are represented as Atom Feed entries
• tools.ietf.org/html...

APP: WordPress
• WordPress offers limited functionality
• Requires Authentication
• Supported on all WordPress sites
(Op...

APP: Features
• Get/Create/Edit/Delete
• Posts, Pages
• Media Uploads

APP: Auth
• All APP calls require authentication
• BASIC (Username/Password)
• Extensible via Plugin

APP: Example

APP: Example

...

APP: Evaluation
• Data: Posts only
• Easy: Not really. At least it’s XML.
• Docs: No
• Grok: Looks like a feed
• CLI: No

APP: Conclusion
• Pro: Aesthetically cool
• Cons
• Not very well supported in WordPress
• Hard to extend
• Poorly docum...

“REST”ful JSON
• WordPress.COM has launched a new
RESTful JSON API
• Soon in Jetpack
• Will likely be in core (3.6?)

“REST”ful JSON
• Fairly full featured
• Public data does not require authentication
• Private data requires OAuth2
• True ...

JSON: Features
• Get/Create/Edit/Delete
• Posts, Pages
• Comments
• Terms, Taxonomies
• Media Uploads

JSON: “REST”
https://public-api.wordpress.com/rest/v1/sites/$site

• Read: GET /posts/$post_id
• Create: POST /posts/n...

JSON: Docs
• Dynamically generated: always up to date
• developer.wordpress.com/docs/api/
• Append “/help” to any API URL
...

JSON: Tools
• Command Line: curl
• PHP: file_get_contents()
• WordPress: wp_remote_request()
• JS:Yes
• Any language that ...

JSON: Examples
• Get most recent post
public-api.wordpress.com/rest/v1/sites/
en.blog.wordpress.com/posts/?number=1
...

JSON: Examples
• Create a Post
curl --data 'title=WCOC'
--data 'content=Rocks'
-H 'Authorization:
...

JSON: Evaluation
• Data: Not as fully featured as XML-RPC
• Easy:Yes
• Docs:Yes!
• Grok:Yes
• CLI:Yes!

JSON: Conclusion
• Pros
• Easiest to use
• Built in up-to-date documentation
• True representation of for-display and
...

Bye
• Mike Adams = mdawaffe

Bye
• Mike Adams = mdawaffe
• Thanks!

WordPress APIs

You are reading a preview.

Activate your 30 day free trial to continue reading.

Share SlideShare

Facebook
Twitter
LinkedIn

Embed

Size (px)

Show related SlideShares at end

WordPress Shortcode

Link

LinkedIn
Facebook
Twitter
Email

Replay

Top clipped slide

1 of 48 Ad

1 of 48 Ad