Context Navigation

← Previous Change
Next Change →

class-wp-xmlrpc-server.php

Timestamp:

05/22/2015 07:36:22 PM (11 years ago)

Author:

wonderboymusic

Message:

Upgrade the doc blocks in class-wp-xmlrpc-server.php. Rehabilitate some unfortunate use of tabbing.

See #32444.

File:

: 1 edited

trunk/src/wp-includes/class-wp-xmlrpc-server.php (modified) (105 diffs)

Legend:

: Unmodified
: Added
: Removed

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

-              r32477
+              r32550
          * @param callable $name      Method to call.
          * @param array    $arguments Arguments to pass when calling.
          * @return mixed|bool Return value of the callback, false otherwise.
+         * @return array|IXR_Error|false Return value of the callback, false otherwise.
          */
         public function __call( $name, $arguments ) {
 …
          * @since 1.5.0
+         *
-         * @param array $args Method Parameters.
          * @return string
          */
         public function sayHello($args) {
+        public function sayHello() {
                 return 'Hello!';
+        }
 …
          * @since 1.5.0
+         *
+         * @param array $args Method Parameters.
+         * @param array  $args {
+         *     Method parameters.
+         *
+         *     @type int $number1  A number to add.
+         *     @type int $number2  A second number to add.
+         * }
          * @return int
          */
         public function addTwoNumbers($args) {
+        public function addTwoNumbers( $args ) {
                 $number1 = $args[0];
                 $number2 = $args[1];
 …
+         *
          * @param string|array $data Escape single string or array of strings.
+         * @return string|array Type matches $data and sanitized for the database.
+         * @return string|null Returns with string is passed, alters by-reference
+         *                     when array is passed.
          */
         public function escape( &$data ) {
 …
+         *
          * @since 2.6.0
+         *
+         * @global string $wp_version
          */
         public function initialise_blog_option_info() {
 …
          * @since 2.6.0
+         *
+         * @param array $args Method parameters. Contains:
+         *  - username
+         *  - password
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error Array contains:
          *  - 'isAdmin'
 …
          * @param string|array $args Sanitize single string or array of strings.
          * @param int $count Minimum number of arguments.
          * @return boolean if $args contains at least $count arguments.
+         * @return bool if $args contains at least $count arguments.
          */
         protected function minimum_args( $args, $count ) {
 …
         protected function _prepare_term( $term ) {
                 $_term = $term;
                 if ( ! is_array( $_term) )
+                if ( ! is_array( $_term ) )
                         $_term = get_object_vars( $_term );
 …
          * @since 3.4.0
+         *
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - array   $content_struct
+         *      $content_struct can contain:
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $content_struct can contain:
          *      - post_type (default: 'post')
          *      - post_status (default: 'draft')
 …
          *      - enclosure
          *      - any other fields supported by wp_insert_post()
+         * }
          * @return string|IXR_Error post_id
          */
 …
          * @param WP_User $user The post author if post_author isn't set in $content_struct.
          * @param array|IXR_Error $content_struct Post data to insert.
+         * @return IXR_Error|string
          */
         protected function _insert_post( $user, $content_struct ) {
 …
          * @since 3.4.0
+         *
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - int     $post_id
+         *  - array   $content_struct
+         * @return bool|IXR_Error true on success
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $post_id
+         *     @type array  $content_struct
+         * }
+         * @return true|IXR_Error true on success
          */
         public function wp_editPost( $args ) {
 …
+         *
          * @uses wp_delete_post()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - int     $post_id
+         * @return bool|IXR_Error true on success
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $post_id
+         * }
+         * @return true|IXR_Error true on success
          */
         public function wp_deletePost( $args ) {
 …
                 $this->escape( $args );
                 $username           = $args[1];
                 $password           = $args[2];
                 $post_id            = (int) $args[3];
+                $username = $args[1];
+                $password = $args[2];
+                $post_id  = (int) $args[3];
                 if ( isset( $args[4] ) ) {
 …
                 $this->escape( $args );
                 $username   = $args[1];
                 $password   = $args[2];
                 $filter     = isset( $args[3] ) ? $args[3] : array();
+                $username = $args[1];
+                $password = $args[2];
+                $filter   = isset( $args[3] ) ? $args[3] : array();
                 if ( isset( $args[4] ) ) {
 …
                 $this->escape( $args );
                 $username           = $args[1];
                 $password           = $args[2];
                 $content_struct     = $args[3];
+                $username       = $args[1];
+                $password       = $args[2];
+                $content_struct = $args[3];
                 if ( ! $user = $this->login( $username, $password ) )
 …
          *      - 'description'
          *      - 'slug'
          * @return bool|IXR_Error True, on success.
+         * @return true|IXR_Error True, on success.
          */
         public function wp_editTerm( $args ) {
 …
                 $this->escape( $args );
                 $username           = $args[1];
                 $password           = $args[2];
                 $term_id            = (int) $args[3];
                 $content_struct     = $args[4];
+                $username       = $args[1];
+                $password       = $args[2];
+                $term_id        = (int) $args[3];
+                $content_struct = $args[4];
                 if ( ! $user = $this->login( $username, $password ) )
 …
+         *
          * @uses wp_delete_term()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - string  $taxnomy_name
+         *  - string     $term_id
+         * @return boolean|IXR_Error If it suceeded true else a reason why not
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type string $taxnomy_name
+         *     @type string $term_id
+         * }
+         * @return bool|IXR_Error If it suceeded true else a reason why not
          */
         public function wp_deleteTerm( $args ) {
 …
+         *
          * @uses get_term()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - string  $taxonomy
+         *  - string  $term_id
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type string $taxnomy
+         *     @type string $term_id
+         * }
          * @return array|IXR_Error Array contains:
          *  - 'term_id'
 …
+         *
          * @uses get_terms()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - string  $taxonomy
+         *  - array   $filter optional
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type string $taxnomy
+         *     @type array  $filter (optional)
+         * }
          * @return array|IXR_Error terms
          */
 …
+         *
          * @uses get_taxonomy()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - string  $taxonomy
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type string $taxnomy
+         *     @type array  $fields (optional)
+         * }
          * @return array|IXR_Error (@see get_taxonomy())
          */
 …
                 $this->escape( $args );
                 $username       = $args[1];
                 $password       = $args[2];
                 $taxonomy       = $args[3];
+                $username = $args[1];
+                $password = $args[2];
+                $taxonomy = $args[3];
                 if ( isset( $args[4] ) ) {
 …
+         *
          * @uses get_taxonomies()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array taxonomies
          */
 …
                 $this->escape( $args );
                 $username           = $args[1];
                 $password           = $args[2];
                 $filter             = isset( $args[3] ) ? $args[3] : array( 'public' => true );
+                $username = $args[1];
+                $password = $args[2];
+                $filter   = isset( $args[3] ) ? $args[3] : array( 'public' => true );
                 if ( isset( $args[4] ) ) {
 …
+         *
          * @uses get_userdata()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - int     $user_id
+         *  - array   $fields optional
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $user_id
+         *     @type array  $fields (optional)
+         * }
          * @return array|IXR_Error Array contains (based on $fields parameter):
          *  - 'user_id'
 …
                 $this->escape( $args );
                 $username   = $args[1];
                 $password   = $args[2];
                 $user_id    = (int) $args[3];
+                $username = $args[1];
+                $password = $args[2];
+                $user_id  = (int) $args[3];
                 if ( isset( $args[4] ) ) {
 …
          * @see wp_getUser() for more on $fields and return values
+         *
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - array   $filter optional
+         *  - array   $fields optional
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $filter (optional)
+         *     @type array  $fields (optional)
+         * }
          * @return array|IXR_Error users data
          */
 …
                 $this->escape( $args );
                 $username   = $args[1];
                 $password   = $args[2];
                 $filter     = isset( $args[3] ) ? $args[3] : array();
+                $username = $args[1];
+                $password = $args[2];
+                $filter   = isset( $args[3] ) ? $args[3] : array();
                 if ( isset( $args[4] ) ) {
 …
+         *
          * @uses get_userdata()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - array   $fields optional
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $fields (optional)
+         * }
          * @return array|IXR_Error (@see wp_getUser)
          */
 …
                 $this->escape( $args );
                 $username   = $args[1];
                 $password   = $args[2];
+                $username = $args[1];
+                $password = $args[2];
                 if ( isset( $args[3] ) ) {
 …
+         *
          * @uses wp_update_user()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - array   $content_struct
+         *      It can optionally contain:
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $content_struct It can optionally contain:
          *      - 'first_name'
          *      - 'last_name'
 …
          *      - 'nicename'
          *      - 'bio'
+         * @return bool|IXR_Error True, on success.
+         * }
+         * @return true|IXR_Error True, on success.
          */
         public function wp_editProfile( $args ) {
 …
          * @since 2.2.0
+         *
+         * @param array $args Method parameters. Contains:
+         *  - blog_id (unused)
+         *  - page_id
+         *  - username
+         *  - password
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type int    $page_id
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
         public function wp_getPage($args) {
                 $this->escape($args);
                 $page_id        = (int) $args[1];
                 $username       = $args[2];
                 $password       = $args[3];
+        public function wp_getPage( $args ) {
+                $this->escape( $args );
+                $page_id  = (int) $args[1];
+                $username = $args[2];
+                $password = $args[3];
                 if ( !$user = $this->login($username, $password) ) {
 …
          * @since 2.2.0
+         *
+         * @param array $args Method parameters. Contains:
+         *  - blog_id (unused)
+         *  - username
+         *  - password
+         *  - num_pages
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $num_pages
+         * }
          * @return array|IXR_Error
          */
         public function wp_getPages($args) {
                 $this->escape($args);
                 $username       = $args[1];
                 $password       = $args[2];
                 $num_pages      = isset($args[3]) ? (int) $args[3] : 10;
+        public function wp_getPages( $args ) {
+                $this->escape( $args );
+                $username  = $args[1];
+                $password  = $args[2];
+                $num_pages = isset($args[3]) ? (int) $args[3] : 10;
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.2.0
+         *
+         * @param array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()}
+         * @param array  $args {
+         *     See {@link wp_xmlrpc_server::mw_newPost()}
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $content_struct
+         * }
          * @return int|IXR_Error
          */
         public function wp_newPage($args) {
+        public function wp_newPage( $args ) {
                 // Items not escaped here will be escaped in newPost.
                 $username       = $this->escape($args[1]);
                 $password       = $this->escape($args[2]);
+                $username = $this->escape( $args[1] );
+                $password = $this->escape( $args[2] );
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.2.0
+         *
+         * @param array $args Method parameters.
+         * @return bool|IXR_Error True, if success.
+         */
+        public function wp_deletePage($args) {
+                $this->escape($args);
+                $username       = $args[1];
+                $password       = $args[2];
+                $page_id        = (int) $args[3];
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $page_id
+         * }
+         * @return true|IXR_Error True, if success.
+         */
+        public function wp_deletePage( $args ) {
+                $this->escape( $args );
+                $username = $args[1];
+                $password = $args[2];
+                $page_id  = (int) $args[3];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.2.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type int    $page_id
+         *     @type string $username
+         *     @type string $password
+         *     @type string $content
+         *     @type string $publish
+         * }
          * @return array|IXR_Error
          */
         public function wp_editPage($args) {
+        public function wp_editPage( $args ) {
                 // Items not escaped here will be escaped in editPost.
                 $page_id        = (int) $this->escape($args[1]);
                 $username       = $this->escape($args[2]);
                 $password       = $this->escape($args[3]);
                 $content        = $args[4];
                 $publish        = $args[5];
+                $page_id  = (int) $this->escape($args[1]);
+                $username = $this->escape($args[2]);
+                $password = $this->escape($args[3]);
+                $content  = $args[4];
+                $publish  = $args[5];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.2.0
+         *
+         * @param array $args Method parameters.
+         * @global wpdb $wpdb
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
         public function wp_getPageList($args) {
+        public function wp_getPageList( $args ) {
                 global $wpdb;
                 $this->escape($args);
                 $username                               = $args[1];
                 $password                               = $args[2];
+                $this->escape( $args );
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.2.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
+        public function wp_getAuthors($args) {
+                $this->escape($args);
+                $username       = $args[1];
+                $password       = $args[2];
+        public function wp_getAuthors( $args ) {
+                $this->escape( $args );
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.7.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
 …
                 $this->escape( $args );
                 $username               = $args[1];
                 $password               = $args[2];
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.2.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $category
+         * }
          * @return int|IXR_Error Category ID.
          */
         public function wp_newCategory($args) {
                 $this->escape($args);
                 $username                               = $args[1];
                 $password                               = $args[2];
                 $category                               = $args[3];
+        public function wp_newCategory( $args ) {
+                $this->escape( $args );
+                $username = $args[1];
+                $password = $args[2];
+                $category = $args[3];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $category_id
+         * }
          * @return bool|IXR_Error See {@link wp_delete_term()} for return info.
          */
         public function wp_deleteCategory($args) {
                 $this->escape($args);
                 $username               = $args[1];
                 $password               = $args[2];
                 $category_id    = (int) $args[3];
+        public function wp_deleteCategory( $args ) {
+                $this->escape( $args );
+                $username    = $args[1];
+                $password    = $args[2];
+                $category_id = (int) $args[3];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.2.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $category
+         *     @type int    $max_results
+         * }
          * @return array|IXR_Error
          */
         public function wp_suggestCategories($args) {
                 $this->escape($args);
                 $username                               = $args[1];
                 $password                               = $args[2];
                 $category                               = $args[3];
                 $max_results                    = (int) $args[4];
+        public function wp_suggestCategories( $args ) {
+                $this->escape( $args );
+                $username    = $args[1];
+                $password    = $args[2];
+                $category    = $args[3];
+                $max_results = (int) $args[4];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.7.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $comment_id
+         * }
          * @return array|IXR_Error
          */
 …
          * @since 2.7.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $struct
+         * }
          * @return array|IXR_Error Contains a collection of comments. See {@link wp_xmlrpc_server::wp_getComment()} for a description of each item contents
          */
         public function wp_getComments($args) {
                 $this->escape($args);
                 $username       = $args[1];
                 $password       = $args[2];
                 $struct         = isset( $args[3] ) ? $args[3] : array();
+        public function wp_getComments( $args ) {
+                $this->escape( $args );
+                $username = $args[1];
+                $password = $args[2];
+                $struct   = isset( $args[3] ) ? $args[3] : array();
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.7.0
+         *
+         * @param array $args Method parameters. Contains:
+         *  - blog_id (unused)
+         *  - username
+         *  - password
+         *  - comment_id
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $comment_ID
+         * }
          * @return bool|IXR_Error {@link wp_delete_comment()}
          */
 …
          * @since 2.7.0
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $comment_ID
+         *     @type array  $content_struct
+         * }
          * @param array $args Contains:
          *  - blog_id (unused)
 …
          *  - comment_id
          *  - content_struct
          * @return bool|IXR_Error True, on success.
          */
         public function wp_editComment($args) {
                 $this->escape($args);
+         * @return true|IXR_Error True, on success.
+         */
+        public function wp_editComment( $args ) {
+                $this->escape( $args );
                 $username       = $args[1];
 …
          * @since 2.7.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int        $blog_id (unused)
+         *     @type string     $username
+         *     @type string     $password
+         *     @type string|int $post
+         *     @type array      $content_struct
+         * }
          * @return int|IXR_Error {@link wp_new_comment()}
          */
 …
                 $this->escape($args);
                 $username       = $args[1];
                 $password       = $args[2];
                 $post           = $args[3];
+                $username       = $args[1];
+                $password       = $args[2];
+                $post           = $args[3];
                 $content_struct = $args[4];
 …
          * @since 2.7.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
 …
                 $this->escape( $args );
                 $username       = $args[1];
                 $password       = $args[2];
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $post_id
+         * }
          * @return array|IXR_Error
          */
         public function wp_getCommentCount( $args ) {
                 $this->escape($args);
+                $this->escape( $args );
                 $username       = $args[1];
 …
          * @since 2.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
 …
                 $this->escape( $args );
                 $username       = $args[1];
                 $password       = $args[2];
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
 …
                 $this->escape( $args );
                 $username       = $args[1];
                 $password       = $args[2];
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.6.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
 …
                 $this->escape( $args );
                 $username       = $args[1];
                 $password       = $args[2];
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.6.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $options
+         * }
          * @return array|IXR_Error
          */
 …
          * @since 2.6.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $options
+         * }
          * @return array|IXR_Error
          */
 …
          * @since 3.1.0
+         *
+         * @param array $args Method parameters. Contains:
+         *  - blog_id (unused)
+         *  - username
+         *  - password
+         *  - attachment_id
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $attachment_id
+         * }
          * @return array|IXR_Error Associative array contains:
          *  - 'date_created_gmt'
 …
          *  - 'metadata'
          */
         public function wp_getMediaItem($args) {
                 $this->escape($args);
+        public function wp_getMediaItem( $args ) {
+                $this->escape( $args );
                 $username               = $args[1];
 …
          * @since 3.1.0
+         *
+         * @param array $args Method parameters. Contains:
+         *  - blog_id (unused)
+         *  - username
+         *  - password
+         *  - filter
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $struct
+         * }
          * @return array|IXR_Error Contains a collection of media items. See {@link wp_xmlrpc_server::wp_getMediaItem()} for a description of each item contents
          */
 …
           * @since 3.1.0
+          *
+          * @param array $args Method parameters. Contains:
+          *  - blog_id (unused)
+          *  - username
+          *  - password
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
           * @return array|IXR_Error
           */
 …
+         *
          * @uses get_post_type_object()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - string  $post_type_name
+         *  - array   $fields
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type string $post_type_name
+         *     @type array  $fields (optional)
+         * }
          * @return array|IXR_Error Array contains:
          *  - 'labels'
 …
+         *
          * @uses get_post_types()
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - array   $filter
+         *  - array   $fields
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $filter (optional)
+         *     @type array  $fields (optional)
+         * }
          * @return array|IXR_Error
          */
 …
                 $this->escape( $args );
                 $username           = $args[1];
                 $password           = $args[2];
                 $filter             = isset( $args[3] ) ? $args[3] : array( 'public' => true );
+                $username = $args[1];
+                $password = $args[2];
+                $filter   = isset( $args[3] ) ? $args[3] : array( 'public' => true );
                 if ( isset( $args[4] ) ) {
 …
          * @see wp_getPost() for more on $fields
+         *
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - int     $post_id
+         *  - array   $fields
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $post_id
+         *     @type array  $fields (optional)
+         * }
          * @return array|IXR_Error contains a collection of posts.
          */
 …
                 $this->escape( $args );
                 $username   = $args[1];
                 $password   = $args[2];
                 $post_id    = (int) $args[3];
+                $username = $args[1];
+                $password = $args[2];
+                $post_id  = (int) $args[3];
                 if ( isset( $args[4] ) ) {
 …
          * @uses wp_restore_post_revision()
+         *
+         * @param array $args Method parameters. Contains:
+         *  - int     $blog_id (unused)
+         *  - string  $username
+         *  - string  $password
+         *  - int     $post_id
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $revision_id
+         * }
          * @return bool|IXR_Error false if there was an error restoring, true if success.
          */
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
 …
                 $username = $args[1];
                 $password  = $args[2];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
+        public function blogger_getUserInfo($args) {
+                $this->escape($args);
+        public function blogger_getUserInfo( $args ) {
+                $this->escape( $args );
                 $username = $args[1];
                 $password  = $args[2];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type int    $post_ID
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
+        public function blogger_getPost($args) {
+                $this->escape($args);
+                $post_ID    = (int) $args[1];
+        public function blogger_getPost( $args ) {
+                $this->escape( $args );
+                $post_ID  = (int) $args[1];
                 $username = $args[2];
                 $password  = $args[3];
+                $password = $args[3];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type string $appkey (unused)
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $numberposts (optional)
+         * }
          * @return array|IXR_Error
          */
         public function blogger_getRecentPosts($args) {
+        public function blogger_getRecentPosts( $args ) {
                 $this->escape($args);
 …
                 // $args[0] = appkey - ignored
                 $username = $args[2];
                 $password  = $args[3];
+                $password = $args[3];
                 if ( isset( $args[4] ) )
                         $query = array( 'numberposts' => absint( $args[4] ) );
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type string $appkey (unused)
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type string $content
+         *     @type string $publish
+         * }
          * @return int|IXR_Error
          */
+        public function blogger_newPost($args) {
+                $this->escape($args);
+        public function blogger_newPost( $args ) {
+                $this->escape( $args );
                 $username = $args[2];
                 $password  = $args[3];
                 $content    = $args[4];
                 $publish    = $args[5];
+                $password = $args[3];
+                $content  = $args[4];
+                $publish  = $args[5];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @return bool|IXR_Error true when done.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type int    $post_ID
+         *     @type string $username
+         *     @type string $password
+         *     @type string $content
+         * }
+         * @return true|IXR_Error true when done.
          */
         public function blogger_editPost( $args ) {
 …
                 $this->escape($args);
                 $post_ID     = (int) $args[1];
                 $username  = $args[2];
                 $password   = $args[3];
                 $content     = $args[4];
+                $post_ID  = (int) $args[1];
+                $username = $args[2];
+                $password = $args[3];
+                $content  = $args[4];
                 if ( ! $user = $this->login( $username, $password ) ) {
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @return bool|IXR_Error True when post is deleted.
+         */
+        public function blogger_deletePost($args) {
+                $this->escape($args);
+                $post_ID     = (int) $args[1];
+                $username  = $args[2];
+                $password   = $args[3];
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type int    $post_ID
+         *     @type string $username
+         *     @type string $password
+         * }
+         * @return true|IXR_Error True when post is deleted.
+         */
+        public function blogger_deletePost( $args ) {
+                $this->escape( $args );
+                $post_ID  = (int) $args[1];
+                $username = $args[2];
+                $password = $args[3];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters. Contains:
+         *  - blog_id (unused)
+         *  - username
+         *  - password
+         *  - content_struct
+         *  - publish
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $content_struct
+         *     @type int    $publish
+         * }
          * @return int|IXR_Error
          */
 …
                 $this->escape($args);
                 $username  = $args[1];
                 $password   = $args[2];
+                $username       = $args[1];
+                $password       = $args[2];
                 $content_struct = $args[3];
                 $publish     = isset( $args[4] ) ? $args[4] : 0;
+                $publish        = isset( $args[4] ) ? $args[4] : 0;
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 2.1.0
+         *
+         * @global wpdb $wpdb
+         *
          * @param int $post_ID Post ID.
          * @param string $post_content Post Content for attachment.
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $content_struct
+         *     @type int    $publish
+         * }
          * @return bool|IXR_Error True on success.
          */
+        public function mw_editPost($args) {
+                $this->escape($args);
+        public function mw_editPost( $args ) {
+                $this->escape( $args );
                 $post_ID        = (int) $args[0];
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type int    $post_ID
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
+        public function mw_getPost($args) {
+                $this->escape($args);
+                $post_ID     = (int) $args[0];
+                $username  = $args[1];
+                $password   = $args[2];
+        public function mw_getPost( $args ) {
+                $this->escape( $args );
+                $post_ID  = (int) $args[0];
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $numberposts
+         * }
          * @return array|IXR_Error
          */
+        public function mw_getRecentPosts($args) {
+                $this->escape($args);
+                $username  = $args[1];
+                $password   = $args[2];
+        public function mw_getRecentPosts( $args ) {
+                $this->escape( $args );
+                $username = $args[1];
+                $password = $args[2];
                 if ( isset( $args[3] ) )
                         $query = array( 'numberposts' => absint( $args[3] ) );
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
+        public function mw_getCategories($args) {
+                $this->escape($args);
+                $username  = $args[1];
+                $password   = $args[2];
+        public function mw_getCategories( $args ) {
+                $this->escape( $args );
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @global wpdb $wpdb
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $data
+         * }
          * @return array|IXR_Error
          */
         public function mw_newMediaObject($args) {
+        public function mw_newMediaObject( $args ) {
                 global $wpdb;
                 $username  = $this->escape($args[1]);
                 $password   = $this->escape($args[2]);
                 $data        = $args[3];
+                $username = $this->escape( $args[1] );
+                $password = $this->escape( $args[2] );
+                $data     = $args[3];
                 $name = sanitize_file_name( $data['name'] );
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         *     @type int    $numberposts
+         * }
          * @return array|IXR_Error
          */
+        public function mt_getRecentPostTitles($args) {
+                $this->escape($args);
+                $username  = $args[1];
+                $password   = $args[2];
+        public function mt_getRecentPostTitles( $args ) {
+                $this->escape( $args );
+                $username = $args[1];
+                $password = $args[2];
                 if ( isset( $args[3] ) )
                         $query = array( 'numberposts' => absint( $args[3] ) );
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $blog_id (unused)
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
+        public function mt_getCategoryList($args) {
+                $this->escape($args);
+                $username  = $args[1];
+                $password   = $args[2];
+        public function mt_getCategoryList( $args ) {
+                $this->escape( $args );
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $post_ID
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return array|IXR_Error
          */
+        public function mt_getPostCategories($args) {
+                $this->escape($args);
+                $post_ID     = (int) $args[0];
+                $username  = $args[1];
+                $password   = $args[2];
+        public function mt_getPostCategories( $args ) {
+                $this->escape( $args );
+                $post_ID  = (int) $args[0];
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @return bool|IXR_Error True on success.
+         */
+        public function mt_setPostCategories($args) {
+                $this->escape($args);
+                $post_ID     = (int) $args[0];
+                $username  = $args[1];
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $post_ID
+         *     @type string $username
+         *     @type string $password
+         *     @type array  $categories
+         * }
+         * @return true|IXR_Error True on success.
+         */
+        public function mt_setPostCategories( $args ) {
+                $this->escape( $args );
+                $post_ID    = (int) $args[0];
+                $username   = $args[1];
                 $password   = $args[2];
                 $categories  = $args[3];
+                $categories = $args[3];
                 if ( !$user = $this->login($username, $password) )
 …
          * @since 1.5.0
+         *
-         * @param array $args Method parameters.
          * @return array
          */
+        public function mt_supportedMethods($args) {
+        public function mt_supportedMethods() {
                 /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
                 do_action( 'xmlrpc_call', 'mt.supportedMethods' );
+                $supported_methods = array();
+                foreach ( $this->methods as $key => $value ) {
+                        $supported_methods[] = $key;
+                }
+                return $supported_methods;
+                return array_keys( $this->methods );
+        }
 …
+         *
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         */
+        public function mt_supportedTextFilters($args) {
+         */
+        public function mt_supportedTextFilters() {
                 /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
                 do_action( 'xmlrpc_call', 'mt.supportedTextFilters' );
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @global wpdb $wpdb
+         *
+         * @param int $post_ID
          * @return array|IXR_Error
          */
+        public function mt_getTrackbackPings($args) {
+        public function mt_getTrackbackPings( $post_ID ) {
                 global $wpdb;
-                $post_ID = intval($args);
                 /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type int    $post_ID
+         *     @type string $username
+         *     @type string $password
+         * }
          * @return int|IXR_Error
          */
+        public function mt_publishPost($args) {
+                $this->escape($args);
+                $post_ID     = (int) $args[0];
+                $username  = $args[1];
+                $password   = $args[2];
+        public function mt_publishPost( $args ) {
+                $this->escape( $args );
+                $post_ID  = (int) $args[0];
+                $username = $args[1];
+                $password = $args[2];
                 if ( !$user = $this->login($username, $password) )
 …
                 $this->escape($postdata);
+                $result = wp_update_post($postdata);
+                return $result;
+                return wp_update_post( $postdata );
+        }
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @global wpdb $wpdb
+         * @global string $wp_version
+         *
+         * @param array  $args {
+         *     Method parameters, in this order:
+         *
+         *     @type string $pagelinkedfrom
+         *     @type string $pagelinkedto
+         * }
          * @return string|IXR_Error
          */
         public function pingback_ping($args) {
                 global $wpdb;
+        public function pingback_ping( $args ) {
+                global $wpdb, $wp_version;
                 /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
                 do_action( 'xmlrpc_call', 'pingback.ping' );
+                $this->escape($args);
+                $pagelinkedfrom = $args[0];
+                $pagelinkedto   = $args[1];
+                $pagelinkedfrom = str_replace('&amp;', '&', $pagelinkedfrom);
+                $pagelinkedto = str_replace('&amp;', '&', $pagelinkedto);
+                $pagelinkedto = str_replace('&', '&amp;', $pagelinkedto);
+                $this->escape( $args );
+                $pagelinkedfrom = str_replace( '&amp;', '&', $args[0] );
+                $pagelinkedto = str_replace( '&amp;', '&', $args[1] );
+                $pagelinkedto = str_replace( '&', '&amp;', $pagelinkedto );
                 /**
 …
                 /** This filter is documented in wp-includes/class-http.php */
                 $user_agent = apply_filters( 'http_headers_useragent', 'WordPress/' . $GLOBALS['wp_version'] . '; ' . get_bloginfo( 'url' ) );
+                $user_agent = apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ) );
                 // Let's check the remote site
 …
          * @since 1.5.0
+         *
+         * @param array $args Method parameters.
+         * @global wpdb $wpdb
+         *
+         * @param string $url
          * @return array|IXR_Error
          */
+        public function pingback_extensions_getPingbacks($args) {
+        public function pingback_extensions_getPingbacks( $url ) {
                 global $wpdb;
 …
                 do_action( 'xmlrpc_call', 'pingback.extensions.getPingbacks' );
+                $this->escape($args);
+                $url = $args;
+                $url = $this->escape( $url );
                 $post_ID = url_to_postid($url);
 …
          * @param integer $code
          * @param string $message
+         * @return IXR_Error
          */
         protected function pingback_error( $code, $message ) {

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core

Context Navigation

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

Legend:

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

Download in other formats: