<!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>[17647] trunk/wp-includes/class-wp-xmlrpc-server.php:
More better phpdoc for XMLRPC functions.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/17647">17647</a></dd>
<dt>Author</dt> <dd>westi</dd>
<dt>Date</dt> <dd>2011-04-18 07:26:42 +0000 (Mon, 18 Apr 2011)</dd>
</dl>
<h3>Log Message</h3>
<pre>More 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 (17646 => 17647)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/class-wp-xmlrpc-server.php 2011-04-18 07:23:47 UTC (rev 17646)
+++ trunk/wp-includes/class-wp-xmlrpc-server.php 2011-04-18 07:26:42 UTC (rev 17647)
</span><span class="lines">@@ -1035,10 +1035,21 @@
</span><span class="cx"> /**
</span><span class="cx"> * Retrieve comments.
</span><span class="cx"> *
</span><ins>+ * Besides the common blog_id, username, and password arguments, it takes a filter
+ * array as last argument.
+ *
+ * Accepted 'filter' keys are 'status', 'post_id', 'offset', and 'number'.
+ *
+ * The defaults are as follows:
+ * - 'status' - Default is ''. Filter by status (e.g., 'approve', 'hold')
+ * - 'post_id' - Default is ''. The post where the comment is posted. Empty string shows all comments.
+ * - 'number' - Default is 10. Total number of media items to retrieve.
+ * - 'offset' - Default is 0. See {@link WP_Query::query()} for more.
+ *
</ins><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><span class="cx"> * @param array $args Method parameters.
</span><del>- * @return array
</del><ins>+ * @return array. Contains a collection of comments. See {@link wp_xmlrpc_server::wp_getComment()} for a description of each item contents
</ins><span class="cx"> */
</span><span class="cx"> function wp_getComments($args) {
</span><span class="cx"> $raw_args = $args;
</span><span class="lines">@@ -1082,6 +1093,7 @@
</span><span class="cx">
</span><span class="cx"> $comments_struct = array();
</span><span class="cx">
</span><ins>+ // FIXME: we already have the comments, why query them again?
</ins><span class="cx"> for ( $i = 0; $i < $num_comments; $i++ ) {
</span><span class="cx"> $comment = wp_xmlrpc_server::wp_getComment(array(
</span><span class="cx"> $raw_args[0], $raw_args[1], $raw_args[2], $comments[$i]->comment_ID,
</span><span class="lines">@@ -1093,11 +1105,19 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Remove comment.
</del><ins>+ * Delete a comment.
</ins><span class="cx"> *
</span><ins>+ * By default, the comment will be moved to the trash instead of deleted.
+ * See {@link wp_delete_comment()} for more information on
+ * this behavior.
+ *
</ins><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param array $args Method parameters.
</del><ins>+ * @param array $args Method parameters. Contains:
+ * - blog_id
+ * - username
+ * - password
+ * - comment_id
</ins><span class="cx"> * @return mixed {@link wp_delete_comment()}
</span><span class="cx"> */
</span><span class="cx"> function wp_deleteComment($args) {
</span><span class="lines">@@ -1128,9 +1148,25 @@
</span><span class="cx"> /**
</span><span class="cx"> * Edit comment.
</span><span class="cx"> *
</span><ins>+ * Besides the common blog_id, username, and password arguments, it takes a
+ * comment_id integer and a content_struct array as last argument.
+ *
+ * The allowed keys in the content_struct array are:
+ * - 'author'
+ * - 'author_url'
+ * - 'author_email'
+ * - 'content'
+ * - 'date_created_gmt'
+ * - 'status'. Common statuses are 'approve', 'hold', 'spam'. See {@link get_comment_statuses()} for more details
+ *
</ins><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param array $args Method parameters.
</del><ins>+ * @param array $args. Contains:
+ * - blog_id
+ * - username
+ * - password
+ * - comment_id
+ * - content_struct
</ins><span class="cx"> * @return bool True, on success.
</span><span class="cx"> */
</span><span class="cx"> function wp_editComment($args) {
</span></span></pre>
</div>
</div>
</body>
</html>