Intergrating with WordPress via XML-RPC

Transcript

1. Integrating with WordPress via XML-RPC Max Cutler WordCamp NYC 2012

2. Who am I? • http://maxcutler.com • @maxcutler • Student •

   WordPress for Windows Phone • Core Contributor for XML-RPC in 3.4

3. Motivation What is XML-RPC? WordPress & XML-RPC Examples Tips for

   plugin and theme authors What’s next?

4. Motivation What is XML-RPC? WordPress & XML-RPC Examples Tips for

   plugin and theme authors What’s next?

5. Cross-system interoperability

6. Escape the data silo

7. Motivation What is XML-RPC? WordPress & XML-RPC Examples Tips for

   plugin and theme authors What’s next?

8. “Simple cross-platform distributed computing, based on the standards of the

   Internet.” xmlrpc.com

9. RPC using XML serialization

10. Sample Exchange - Request POST /xmlrpc.php HTTP/1.0 User-Agent: Max’s API

    Client Host: maxcutler.com Content-Type: text/xml <?xml version="1.0"?> <methodCall> <methodName>wp.getUsersBlogs</methodName> <params> <param><value>maxcutler</value></param> <param><value>L1nk3d1nr0ck$</value></param> </params> </methodCall>

11. Sample Exchange - Response HTTP/1.0 200 OK Content-Type: text/xml <?xml

    version="1.0"?> <methodResponse> <params><param><value><array><data><value><struct> <member><name>isAdmin</name> <value><boolean>1</boolean></value></member> <member><name>url</name> <value>http://www.maxcutler.com/</value></member> <member><name>blogid</name> <value>1</value></member> <member><name>blogName</name> <value>Max Cutler</value></member> <member><name>xmlrpc</name> <value>http://www.maxcutler.com/xmlrpc.php</value></member> </struct></value></data></array></value></param></params> </methodResponse>

12. Libraries for every language • PHP/WordPress – IXR • Python

    – xmlrpclib • Ruby – XMLRPC::Client • Perl – RPC::XML • C# - XML-RPC.NET • Java – ws-xmlrpc • JavaScript – Mimic, node-xmlrpc • And many more…

13. Motivation What is XML-RPC? WordPress & XML-RPC Examples Tips for

    plugin and theme authors What’s next?

14. xmlrpc.php • WordPress.com • Off-by-default on WordPress.org • wp-includes/class- wp-xmlrpc-server.php

15. History • r1348 (May 2004) – xmlrpc.php born • 1.5

    – Blogger, MovableType, metaWeblog, and pingback APIs • 2.2 - Pages • 2.5 – Categories, Custom Fields • 2.6 – Options/Settings • 2.7 – Comments • 3.1 – Media Library (read or upload)

16. History – 3.3 blogger.getUsersBlogs blogger.getUserInfo blogger.getPost blogger.getRecentPosts blogger.newPost blogger.editPost blogger.deletePost

    metaWeblog.newPost metaWeblog.editPost metaWeblog.deletePost metaWeblog.getPost metaWeblog.getRecentPosts metaWeblog.getCategories metaWeblog.newMediaObject metaWeblog.getUsersBlogs pingback.ping pingback.extensions mt.getCategoryList mt.getRecentPostTitles mt.getPostCategories mt.setPostCategories mt.publishPost mt.getTrackbackPings wp.getUsersBlogs wp.getAuthors wp.getPage wp.getPages wp.newPage wp.editPage wp.deletePage wp.getPageList wp.getPageTemplates wp.getPageStatusList wp.getCategories wp.getTags wp.newCategory wp.deleteCategory wp.suggestCategories wp.getCommentCount wp.getComment wp.getComments wp.newComment wp.getCommentStatusList wp.getOptions wp.setOptions wp.uploadFile wp.getMediaItem wp.getMediaLibrary wp.getPostFormats wp.getPostStatusList demo.sayHello demo.addTwoNumbers system.listMethods

17. Can we clean this up? • Limited or no support

    for 3.x core features • Widespread inconsistency of parameters and return values • Abuse of legacy method fields postid title description dateCreated date_created_gmt permaLink link title description mt_excerpt mt_text_more wp_more_text mt_allow_comments mt_allow_pings mt_keywords categories wp_slug wp_password userid wp_author_id wp_author_display_name post_status custom_fields wp_post_format sticky enclosure

18. Today – 3.4 • Unified post types • Unified taxonomies

    • More useful media • Actions & filters • Bug-fixes • Unit tests (!!!) http://codex.wordpress.org/XML-RPC_WordPress_API wp.getPost wp.getPosts wp.newPost wp.editPost wp.deletePost wp.getPostType wp.getPostTypes wp.getPostFormats wp.getPostStatusList wp.getTaxonomy wp.getTaxonomies wp.getTerm wp.getTerms wp.newTerm wp.editTerm wp.deleteTerm wp.getMediaItem wp.getMediaLibrary wp.uploadFile wp.getCommentCount wp.getComment wp.getComments wp.newComment wp.editComment wp.deleteComment wp.getCommentStatusList wp.getOptions wp.setOptions wp.getUsersBlogs wp.getAuthors

19. Method analogies WordPress Core API XML-RPC Method get_posts wp.getPost, wp.getPosts

    wp_insert_post wp.newPost, wp.editPost get_taxonomy wp.getTaxonomy, wp.getTaxonomies get_terms wp.getTerm, wp.getTerms wp_insert_term wp.newTerm wp_update_term wp.editTerm get_post_types wp.getPostType, wp.getPostTypes get_comments wp.getComment, wp.getComments

20. Motivation What is XML-RPC? WordPress & XML-RPC Examples Tips for

    plugin and theme authors What’s next?

21. Clients • Language • Standard Library • 3rd-party libraries &

    wrappers – PHP: IXR_Client (ships with WordPress) – Python: python-wordpress-xmlrpc – Node.js: node-wordpress – C#/.NET: JoeBlogs

22. Post Querying • wp.getPosts – Filter • post_type, number, offset,

    order, orderby – Fields • Meta-fields: post, taxonomies, custom_fields • Individual fields – post_id, post_title, post_date, post_date_gmt, post_modified, post_modified_gmt, post_status, post_type, post_name, post_author, post_password, post_excerpt, post_content, link, comment_status, ping_status, sticky, post_format, terms, custom_fields, enclosure

23. Post Querying wp.getPosts( 0, username, password, array( ‘post_type’ => ‘product’,

    ‘orderby’ => ‘title’, ‘order’ => ‘ASC’ ), array( ‘post_title’, ‘date_modified_gmt’, ‘link’ ) )

24. Post Creation wp.newPost( 0, username, password, array( ‘post_title’ => ‘Hello

    world’, ‘post_content’ => …, ‘terms_names’ => array( ‘post_tag’ => array( ‘day1’ ), ‘category’ => array( ‘introductions’ ) ) ) )

25. Post Creation (2) wp.newPost( 0, username, password, array( ‘post_type’ =>

    ‘product’, ‘post_title’ => ‘ACME’, ‘post_content’ => …, ‘custom_fields’ => array( array( ‘key’ => ‘price’, ‘value’ => 15 ) ) ) )

26. Real world examples

27. Mobile Apps http://wordpress.org/extend/mobile/

28. Offline Writing Applications Windows Live Writer, MarsEdit, ecto, etc.

29. Jetpack

30. Chicago Tribune News Apps Varnish Caching Unit Tests http://blog.apps.chicagotribune.com/2011/06/28/dont-break-the-homepage-using-unit-tests- to-validate-your-wordpress-varnish-caching-strategy/

31. Generate WordPress site using build tools https://github.com/scottgonzalez/grunt-wordpress github.com/jquery/api.jquery.com (XML files

    in git repo) grunt-wordpress (XML-RPC bridge) api.jquery.com (WordPress site)

32. External Search Django + Haystack + Solr

33. Camayak Editorial content production with multiple-site remote publishing Camayak WordPress

    InDesign NITF Drupal

34. Motivation What is XML-RPC? WordPress & XML-RPC Examples Tips for

    plugin and theme authors What’s next?

35. http://codex.wordpress.org/ XML-RPC_Support http://codex.wordpress.org/ XML-RPC_Extending

36. Add/remove methods xmlrpc_methods filter function mynamespace_subtractTwoNumbers( $args ) { $number1

    = (int) $args[0]; $number2 = (int) $args[1]; return $number1 - $number2; } function mynamespace_new_xmlrpc_methods( $methods ) { $methods['mynamespace.subtractTwoNumbers'] = 'mynamespace_subtractTwoNumbers'; return $methods; } add_filter( 'xmlrpc_methods', mynamespace_new_xmlrpc_methods');

37. Adjust return values • xmlrpc_default_*_fields – post, posttype, taxonomy •

    xmlrpc_prepare_* – post, post_type, taxonomy, term, media_item, comment, page • xmlrpc_blog_options • wp_handle_upload • Use the source, Luke!

38. PSA: Omit Trailing “?>”

39. Motivation What is XML-RPC? WordPress & XML-RPC Examples Tips for

    plugin and theme authors What’s next?

40. Using 3.3 or earlier? Shim for 3.4 additions in my

    plugin: http://wordpress.org/extend/plugins /xml-rpc-modernization/

41. WordPress 3.5? User management Even more media enhancements Improved custom

    fields JSON Serialization

42. REST API v1 on http://developer.wordpress.com v2 in core? TBD

43. http://codex.wordpress.org/ XML-RPC_Support

44. Thanks! Q&A