Changeset 20782 for trunk/wp-includes/class-wp-xmlrpc-server.php

Timestamp:

05/14/2012 10:10:01 AM (13 years ago)

Author:

duck_

Message:

Minor XML-RPC documentation improvements. See #20566.

Also make newly introduced _is_greater_than_one() private.

File:

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

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

@@ -494 +494 @@
      * Checks if the method received at least the minimum number of arguments.
      *
-     * @since 3.4
+     * @since 3.4.0
      *
      * @param string|array $args Sanitize single string or array of strings.
@@ -570 +570 @@
      * @access protected
      *
-     * @param $date
+     * @param string $date
      * @return IXR_Date
      */
@@ -581 +581 @@
 
     /**
-     * Convert a WordPress gmt date string to an IXR_Date object.
+     * Convert a WordPress GMT date string to an IXR_Date object.
      *
      * @access protected
      *
-     * @param $date
+     * @param string $date_gmt
+     * @param string $date
      * @return IXR_Date
      */
@@ -729 +730 @@
      *
      * @param object $media_item The unprepared media item data
-     * @param string $size The image size to use for the thumbnail URL
+     * @param string $thumbnail_size The image size to use for the thumbnail URL
      * @return array The prepared media item data
      */
-    protected function _prepare_media_item( $media_item, $thumbnail_size='thumbnail' ) {
+    protected function _prepare_media_item( $media_item, $thumbnail_size = 'thumbnail' ) {
         $_media_item = array(
             'attachment_id'    => strval( $media_item->ID ),
@@ -758 +759 @@
      * @since 3.4.0
      *
-     * @uses wp_insert_post()
      * @param array $args Method parameters. Contains:
      *  - int     $blog_id
@@ -806 +806 @@
     }
 
-    /*
+    /**
      * Helper method for filtering out elements from an array.
      *
      * @since 3.4.0
-     */
-    function _is_greater_than_one( $count ) {
+     *
+     * @param int $count Number to compare to one.
+     */
+    private function _is_greater_than_one( $count ) {
         return $count > 1;
     }
 
-    /*
+    /**
      * Helper method for wp_newPost and wp_editPost, containing shared logic.
      *
      * @since 3.4.0
+     * @uses wp_insert_post()
+     *
+     * @param WP_User $user The post author if post_author isn't set in $content_struct.
+     * @param array $content_struct Post data to insert.
      */
     protected function _insert_post( $user, $content_struct ) {
@@ -1048 +1054 @@
      * Edit a post for any registered post type.
      *
-     * @since 3.4.0
-     *
      * The $content_struct parameter only needs to contain fields that
      * should be changed. All other fields will retain their existing values.
      *
-     * @uses wp_insert_post()
+     * @since 3.4.0
+     *
      * @param array $args Method parameters. Contains:
      *  - int     $blog_id