Changeset 17647

Timestamp:

04/18/2011 07:26:42 AM (14 years ago)

Author:

westi

Message:

More better phpdoc for XMLRPC functions. See #15238 props koke.

File:

• trunk/wp-includes/class-wp-xmlrpc-server.php (modified) (4 diffs)

trunk/wp-includes/class-wp-xmlrpc-server.php

@@ -1036 +1036 @@
      * Retrieve comments.
      *
+     * 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.
+     * 
      * @since 2.7.0
      *
      * @param array $args Method parameters.
-     * @return array
+     * @return array. Contains a collection of comments. See {@link wp_xmlrpc_server::wp_getComment()} for a description of each item contents
      */
     function wp_getComments($args) {
@@ -1083 +1094 @@
         $comments_struct = array();
 
+    // FIXME: we already have the comments, why query them again?
         for ( $i = 0; $i < $num_comments; $i++ ) {
             $comment = wp_xmlrpc_server::wp_getComment(array(
@@ -1094 +1106 @@
 
     /**
-     * Remove comment.
+     * Delete a comment.
+     *
+     * By default, the comment will be moved to the trash instead of deleted.
+     * See {@link wp_delete_comment()} for more information on
+     * this behavior.
      *
      * @since 2.7.0
      *
-     * @param array $args Method parameters.
+     * @param array $args Method parameters. Contains:
+     *  - blog_id
+     *  - username
+     *  - password
+     *  - comment_id
      * @return mixed {@link wp_delete_comment()}
      */
@@ -1129 +1149 @@
      * Edit comment.
      *
+     * 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
+     *
      * @since 2.7.0
      *
-     * @param array $args Method parameters.
+     * @param array $args. Contains:
+     *  - blog_id
+     *  - username
+     *  - password
+     *  - comment_id
+     *  - content_struct
      * @return bool True, on success.
      */