Changeset 17646

Timestamp:

04/18/2011 07:23:47 AM (15 years ago)

Author:

westi

Message:

The beginings of better phpdoc for XMLRPC functions. See #15238 props koke.

File:

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

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

@@ -383 +383 @@
          * @since 2.6.0
          *
-         * @param array $args Method parameters.
-         * @return array
+         * @param array $args Method parameters. Contains:
+         *  - username
+         *  - password
+         * @return array. Contains:
+         *  - 'isAdmin'
+         *  - 'url'
+         *  - 'blogid'
+         *  - 'blogName'
+         *  - 'xmlrpc' - url of xmlrpc endpoint
          */
         function wp_getUsersBlogs( $args ) {
@@ -436 +443 @@
          * @since 2.2.0
          *
-         * @param array $args Method parameters.
+         * @param array $args Method parameters. Contains:
+         *  - blog_id
+         *  - page_id
+         *  - username
+         *  - password
          * @return array
          */
@@ -537 +548 @@
          * @since 2.2.0
          *
-         * @param array $args Method parameters.
+         * @param array $args Method parameters. Contains:
+         *  - blog_id
+         *  - username
+         *  - password
+         *  - num_pages
          * @return array
          */
@@ -583 +598 @@
          * @since 2.2.0
          *
-         * @param array $args Method parameters.
+         * @param array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()}
          * @return unknown
          */
@@ -2074 +2089 @@
         /**
          * Create a new post.
+         * 
+         * 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
          *
          * @since 1.5.0
          *
-         * @param array $args Method parameters.
+         * @param array $args Method parameters. Contains:
+         *  - blog_id
+         *  - username
+         *  - password
+         *  - content_struct
+         *  - publish
          * @return int
          */