Codex

Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Difference between revisions of "XML-RPC Support"

(Add link to and overview information about the WP API extensions.)
(Undo revision 169991 by Annpaul244 (talk))
 
(10 intermediate revisions by 8 users not shown)
Line 1: Line 1:
  +
{{Languages|
WordPress uses an [http://www.xmlrpc.com/ XML-RPC] interface. We currently support the [http://www.blogger.com/developers/api/ Blogger API], [http://www.xmlrpc.com/metaWeblogApi metaWeblog API], and the [http://www.sixapart.com/developers/xmlrpc/movable_type_api/ Movable Type API].
 
  +
{{en|XML-RPC Support}}
  +
{{pt-br|Suporte XML-RPC}}
  +
{{zh-cn|XML-RPC Support}}
  +
}}
  +
WordPress uses an [http://www.xmlrpc.com/ XML-RPC] interface. WordPress has its own implementation for WordPress-specific functionality in an API called the [[XML-RPC WordPress API|WordPress API]]. This should be used when possible, and your client should use the API variants beginning with the <tt>wp</tt> prefix.
   
  +
WordPress also supports the [[XML-RPC Blogger API|Blogger API]], [[XML-RPC MetaWeblog API|metaWeblog API]], [[XML-RPC MovableType API|Movable Type API]], and the [[XML-RPC Pingback API|Pingback API]].
We also implement several extensions to the Movable Type API, in an API we call the [http://codex.wordpress.org/XML-RPC_wp WordPress API]. If possible, your client should use the API variants beginning with the wp prefix.
 
   
 
With WordPress XML-RPC support, you can post to your WordPress blog using many popular [[Weblog_Client|Weblog Clients]]. The XML-RPC system can be [[XML-RPC Extending|extended by WordPress Plugins]] to modify its behavior.
The '''metaWeblog''' and '''MovableType API''' are currently supported with the following exceptions:
 
   
  +
==Enabling XML-RPC==
* The stub <tt>mt.supportedTextFilters</tt> is a dummy stub function that returns an empty string.
 
   
  +
XML-RPC functionality is turned on by default since WordPress 3.5.
   
  +
In previous versions of WordPress, XML-RPC was user enabled. To enable, go to [[Settings_Writing_Screen#Remote_Publishing|Settings > Writing > Remote Publishing]] and check the checkbox.
Extended entries in the MovableType API are automatically converted to/from the WordPress <tt>&lt;!--more--></tt> tag.
 
   
  +
==Endpoint==
'''Thanks to WordPress' XML-RPC support, you can now post to your WordPress blog using many popular [[Weblog_Client|Weblog Clients]].'''
 
   
 
The XML-RPC server/path is:
==Develop Your Own Weblog Client==
 
 
You can always [http://www.dentedreality.com.au/bloggerapi/ develop your own]. Many scripts in Perl, Python, PHP, Applescript and Java have already been written and are ripe for the picking (and tweaking).
 
If you are planning on developing a Mac OS X Dashboard Widget, start with Apple's [http://developer.apple.com/macosx/dashboard.html very detailed documentation].
 
 
Your XML-RPC server/path are as described here:
 
   
 
* If your WordPress root is <tt><nowiki>http://example.com/wordpress/</nowiki></tt>, then you have:
 
* If your WordPress root is <tt><nowiki>http://example.com/wordpress/</nowiki></tt>, then you have:
** Server: <tt><nowiki>http://example.com/</nowiki></tt> (some tools will just want the 'example.com' hostname part)
+
** Server: <tt><nowiki>http://example.com/</nowiki></tt> (some tools need just the 'example.com' hostname part)
 
** Path: <tt>/wordpress/xmlrpc.php</tt>
 
** Path: <tt>/wordpress/xmlrpc.php</tt>
 
** complete URL (just in case): <tt><nowiki>http://example.com/wordpress/xmlrpc.php</nowiki></tt>
 
** complete URL (just in case): <tt><nowiki>http://example.com/wordpress/xmlrpc.php</nowiki></tt>
   
  +
==Related==
   
 
[[Category:Advanced Topics]]
 
[[Category:Advanced Topics]]

Latest revision as of 09:27, 3 November 2020

WordPress uses an XML-RPC interface. WordPress has its own implementation for WordPress-specific functionality in an API called the WordPress API. This should be used when possible, and your client should use the API variants beginning with the wp prefix.

WordPress also supports the Blogger API, metaWeblog API, Movable Type API, and the Pingback API.

With WordPress XML-RPC support, you can post to your WordPress blog using many popular Weblog Clients. The XML-RPC system can be extended by WordPress Plugins to modify its behavior.

Enabling XML-RPC

XML-RPC functionality is turned on by default since WordPress 3.5.

In previous versions of WordPress, XML-RPC was user enabled. To enable, go to Settings > Writing > Remote Publishing and check the checkbox.

Endpoint

The XML-RPC server/path is:

  • If your WordPress root is http://example.com/wordpress/, then you have:
    • Server: http://example.com/ (some tools need just the 'example.com' hostname part)
    • Path: /wordpress/xmlrpc.php
    • complete URL (just in case): http://example.com/wordpress/xmlrpc.php

Related