<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[17646] trunk/wp-includes/class-wp-xmlrpc-server.php:
The beginings of better phpdoc for XMLRPC functions.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/17646">17646</a></dd>
<dt>Author</dt> <dd>westi</dd>
<dt>Date</dt> <dd>2011-04-18 07:23:47 +0000 (Mon, 18 Apr 2011)</dd>
</dl>
<h3>Log Message</h3>
<pre>The beginings of better phpdoc for XMLRPC functions. See <a href="http://trac.wordpress.org/ticket/15238">#15238</a> props koke.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesclasswpxmlrpcserverphp">trunk/wp-includes/class-wp-xmlrpc-server.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesclasswpxmlrpcserverphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/class-wp-xmlrpc-server.php (17645 => 17646)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/class-wp-xmlrpc-server.php 2011-04-18 07:11:05 UTC (rev 17645)
+++ trunk/wp-includes/class-wp-xmlrpc-server.php 2011-04-18 07:23:47 UTC (rev 17646)
</span><span class="lines">@@ -382,8 +382,15 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.6.0
</span><span class="cx"> *
</span><del>- * @param array $args Method parameters.
- * @return array
</del><ins>+ * @param array $args Method parameters. Contains:
+ * - username
+ * - password
+ * @return array. Contains:
+ * - 'isAdmin'
+ * - 'url'
+ * - 'blogid'
+ * - 'blogName'
+ * - 'xmlrpc' - url of xmlrpc endpoint
</ins><span class="cx"> */
</span><span class="cx"> function wp_getUsersBlogs( $args ) {
</span><span class="cx"> global $current_site;
</span><span class="lines">@@ -435,7 +442,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.2.0
</span><span class="cx"> *
</span><del>- * @param array $args Method parameters.
</del><ins>+ * @param array $args Method parameters. Contains:
+ * - blog_id
+ * - page_id
+ * - username
+ * - password
</ins><span class="cx"> * @return array
</span><span class="cx"> */
</span><span class="cx"> function wp_getPage($args) {
</span><span class="lines">@@ -536,7 +547,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.2.0
</span><span class="cx"> *
</span><del>- * @param array $args Method parameters.
</del><ins>+ * @param array $args Method parameters. Contains:
+ * - blog_id
+ * - username
+ * - password
+ * - num_pages
</ins><span class="cx"> * @return array
</span><span class="cx"> */
</span><span class="cx"> function wp_getPages($args) {
</span><span class="lines">@@ -582,7 +597,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.2.0
</span><span class="cx"> *
</span><del>- * @param array $args Method parameters.
</del><ins>+ * @param array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()}
</ins><span class="cx"> * @return unknown
</span><span class="cx"> */
</span><span class="cx"> function wp_newPage($args) {
</span><span class="lines">@@ -2073,10 +2088,36 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Create a new post.
</span><ins>+ *
+ * The 'content_struct' argument must contain:
+ * - title
+ * - description
+ * - mt_excerpt
+ * - mt_text_more
+ * - mt_keywords
+ * - mt_tb_ping_urls
+ * - categories
+ *
+ * Also, it can optionally contain:
+ * - wp_slug
+ * - wp_password
+ * - wp_page_parent_id
+ * - wp_page_order
+ * - wp_author_id
+ * - post_status | page_status - can be 'draft', 'private', 'publish', or 'pending'
+ * - mt_allow_comments - can be 'open' or 'closed'
+ * - mt_allow_pings - can be 'open' or 'closed'
+ * - date_created_gmt
+ * - dateCreated
</ins><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @param array $args Method parameters.
</del><ins>+ * @param array $args Method parameters. Contains:
+ * - blog_id
+ * - username
+ * - password
+ * - content_struct
+ * - publish
</ins><span class="cx"> * @return int
</span><span class="cx"> */
</span><span class="cx"> function mw_newPost($args) {
</span></span></pre>
</div>
</div>
</body>
</html>