Changeset 27730

Timestamp:

03/26/2014 05:43:05 AM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/class-wp-xmlrpc-server.php.

Props kpdesign and DrewAPicture.
Fixes #27506.

File:

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

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

@@ -128 +128 @@
 
         $this->initialise_blog_option_info();
-        $this->methods = apply_filters('xmlrpc_methods', $this->methods);
+
+        /**
+         * Filter the methods exposed by the XML-RPC server.
+         *
+         * This filter can be used to add new methods, and remove built-in methods.
+         *
+         * @since 1.5.0
+         *
+         * @param array $methods An array of XML-RPC methods.
+         */
+        $this->methods = apply_filters( 'xmlrpc_methods', $this->methods );
     }
 
@@ -172 +182 @@
     function login( $username, $password ) {
         // Respect any old filters against get_option() for 'enable_xmlrpc'.
-        $enabled = apply_filters( 'pre_option_enable_xmlrpc', false ); // Deprecated
+
+        /**
+         * Filter whether XML-RPC is enabled.
+         *
+         * @since 3.5.0
+         * @deprecated 3.5.0 Use 'xmlrpc_enabled' instead.
+         *
+         * @param bool $enable Whether to enable XML-RPC. Default false.
+         */
+        $enabled = apply_filters( 'pre_option_enable_xmlrpc', false );
         if ( false === $enabled )
-            $enabled = apply_filters( 'option_enable_xmlrpc', true ); // Deprecated
-
-        // Proper filter for turning off XML-RPC. It is on by default.
+
+            /**
+             * Filter whether XML-RPC is enabled.
+             *
+             * @since 3.5.0
+             * @deprecated 3.5.0 Use 'xmlrpc_enabled' instead.
+             *
+             * @param bool $enable Whether to enable XML-RPC. Default true.
+             */
+            $enabled = apply_filters( 'option_enable_xmlrpc', true );
+
+        /**
+         * Filter whether XML-RPC is enabled.
+         *
+         * This is the proper filter for turning off XML-RPC.
+         *
+         * @since 3.5.0
+         *
+         * @param bool $enabled Whether XML-RPC is enabled. Default true.
+         */
         $enabled = apply_filters( 'xmlrpc_enabled', $enabled );
 
@@ -188 +224 @@
         if (is_wp_error($user)) {
             $this->error = new IXR_Error( 403, __( 'Incorrect username or password.' ) );
+
+            /**
+             * Filter the XML-RPC user login error message.
+             *
+             * @since 3.5.0
+             *
+             * @param string  $error The XML-RPC error message.
+             * @param WP_User $user  WP_User object.
+             */
             $this->error = apply_filters( 'xmlrpc_login_error', $this->error, $user );
             return false;
@@ -442 +487 @@
         );
 
+        /**
+         * Filter the XML-RPC blog options property.
+         *
+         * @since 2.6.0
+         *
+         * @param array $blog_options An array of XML-RPC blog options.
+         */
         $this->blog_options = apply_filters( 'xmlrpc_blog_options', $this->blog_options );
     }
@@ -475 +527 @@
             return $this->error;
 
+        /**
+         * Fires after the XML-RPC user has been authenticated but before the rest of
+         * the method logic begins.
+         *
+         * All built-in XML-RPC methods use the action xmlrpc_call, with a parameter
+         * equal to the method's name, e.g., wp.getUsersBlogs, wp.newPost, etc.
+         *
+         * @since 2.5.0
+         *
+         * @param method $name The method name.
+         */
         do_action( 'xmlrpc_call', 'wp.getUsersBlogs' );
 
@@ -554 +617 @@
             $_taxonomy['object_type'] = array_unique( (array) $taxonomy->object_type );
 
+        /**
+         * Filter XML-RPC-prepared data for the given taxonomy.
+         *
+         * @since 3.4.0
+         *
+         * @param array  $_taxonomy An array of taxonomy data.
+         * @param object $taxonomy  Taxonomy object.
+         * @param array  $fields    The subset of taxonomy fields to return.
+         */
         return apply_filters( 'xmlrpc_prepare_taxonomy', $_taxonomy, $taxonomy, $fields );
     }
@@ -579 +651 @@
         $_term['count'] = intval( $_term['count'] );
 
+        /**
+         * Filter XML-RPC-prepared data for the given term.
+         *
+         * @since 3.4.0
+         *
+         * @param array        $_term An array of term data.
+         * @param array|object $term  Term object or array.
+         */
         return apply_filters( 'xmlrpc_prepare_term', $_term, $term );
     }
@@ -700 +780 @@
         }
 
+        /**
+         * Filter XML-RPC-prepared date for the given post.
+         *
+         * @since 3.4.0
+         *
+         * @param array $_post  An array of modified post data.
+         * @param array $post   An array of post data.
+         * @param array $fields An array of post fields.
+         */
         return apply_filters( 'xmlrpc_prepare_post', $_post, $post, $fields );
     }
@@ -742 +831 @@
             $_post_type['taxonomies'] = get_object_taxonomies( $post_type->name, 'names' );
 
+        /**
+         * Filter XML-RPC-prepared date for the given post type.
+         *
+         * @since 3.4.0
+         *
+         * @param array  $_post_type An array of post type data.
+         * @param object $post_type  Post type object.
+         */
         return apply_filters( 'xmlrpc_prepare_post_type', $_post_type, $post_type );
     }
@@ -772 +869 @@
             $_media_item['thumbnail'] = $_media_item['link'];
 
+        /**
+         * Filter XML-RPC-prepared data for the given media item.
+         *
+         * @since 3.4.0
+         *
+         * @param array  $_media_item    An array of media item data.
+         * @param object $media_item     Media item object.
+         * @param string $thumbnail_size Image size.
+         */
         return apply_filters( 'xmlrpc_prepare_media_item', $_media_item, $media_item, $thumbnail_size );
     }
@@ -843 +949 @@
         );
 
+        /**
+         * Filter XML-RPC-prepared data for the given page.
+         *
+         * @since 3.4.0
+         *
+         * @param array   $_page An array of page data.
+         * @param WP_Post $page  Page object.
+         */
         return apply_filters( 'xmlrpc_prepare_page', $_page, $page );
     }
@@ -885 +999 @@
         );
 
+        /**
+         * Filter XML-RPC-prepared data for the given comment.
+         *
+         * @since 3.4.0
+         *
+         * @param array  $_comment An array of prepared comment data.
+         * @param object $comment  Comment object.
+         */
         return apply_filters( 'xmlrpc_prepare_comment', $_comment, $comment );
     }
@@ -925 +1047 @@
         }
 
+        /**
+         * Filter XML-RPC-prepared data for the given user.
+         *
+         * @since 3.5.0
+         *
+         * @param array   $_user  An array of user data.
+         * @param WP_User $user   User object.
+         * @param array   $fields An array of user fields.
+         */
         return apply_filters( 'xmlrpc_prepare_user', $_user, $user, $fields );
     }
@@ -973 +1104 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.newPost' );
 
@@ -1216 +1348 @@
         $this->attach_uploads( $post_ID, $post_data['post_content'] );
 
+        /**
+         * Filter post data array to be inserted via XML-RPC.
+         *
+         * @since 3.4.0
+         *
+         * @param array $post_data      Parsed array of post data.
+         * @param array $content_struct Post data array.
+         */
         $post_data = apply_filters( 'xmlrpc_wp_insert_post_data', $post_data, $content_struct );
 
@@ -1259 +1399 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.editPost' );
 
@@ -1320 +1461 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.deletePost' );
 
@@ -1395 +1537 @@
             $fields = $args[4];
         else
+
+            /**
+             * Filter the list of post query fields used by the given XML-RPC method.
+             *
+             * @since 3.4.0
+             *
+             * @param array $fields  Array of post fields.
+             * @param string $method Method name.
+             */
             $fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPost' );
 
@@ -1400 +1551 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getPost' );
 
@@ -1448 +1600 @@
         $filter     = isset( $args[3] ) ? $args[3] : array();
 
-        if ( isset( $args[4] ) )
+        if ( isset( $args[4] ) ) {
             $fields = $args[4];
-        else
+        } else {
+            /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
             $fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPosts' );
+        }
 
         if ( ! $user = $this->login( $username, $password ) )
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getPosts' );
 
@@ -1545 +1700 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.newTerm' );
 
@@ -1633 +1789 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.editTerm' );
 
@@ -1725 +1882 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.deleteTerm' );
 
@@ -1792 +1950 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getTerm' );
 
@@ -1845 +2004 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getTerms' );
 
@@ -1916 +2076 @@
         $taxonomy       = $args[3];
 
-        if ( isset( $args[4] ) )
+        if ( isset( $args[4] ) ) {
             $fields = $args[4];
-        else
+        } else {
+            /**
+             * Filter the taxonomy query fields used by the given XML-RPC method.
+             *
+             * @since 3.4.0
+             *
+             * @param array  $fields An array of taxonomy fields to retrieve.
+             * @param string $method The method name.
+             */
             $fields = apply_filters( 'xmlrpc_default_taxonomy_fields', array( 'labels', 'cap', 'object_type' ), 'wp.getTaxonomy' );
+        }
 
         if ( ! $user = $this->login( $username, $password ) )
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getTaxonomy' );
 
@@ -1960 +2130 @@
         $filter             = isset( $args[3] ) ? $args[3] : array( 'public' => true );
 
-        if ( isset( $args[4] ) )
+        if ( isset( $args[4] ) ) {
             $fields = $args[4];
-        else
+        } else {
+            /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
             $fields = apply_filters( 'xmlrpc_default_taxonomy_fields', array( 'labels', 'cap', 'object_type' ), 'wp.getTaxonomies' );
+        }
 
         if ( ! $user = $this->login( $username, $password ) )
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getTaxonomies' );
 
@@ -2029 +2202 @@
         $user_id    = (int) $args[3];
 
-        if ( isset( $args[4] ) )
+        if ( isset( $args[4] ) ) {
             $fields = $args[4];
-        else
+        } else {
+            /**
+             * Filter the default user query fields used by the given XML-RPC method.
+             *
+             * @since 3.5.0
+             *
+             * @param array  $fields User query fields for given method. Default 'all'.
+             * @param string $method The method name.
+             */
             $fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUser' );
+        }
 
         if ( ! $user = $this->login( $username, $password ) )
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getUser' );
 
@@ -2082 +2265 @@
         $filter     = isset( $args[3] ) ? $args[3] : array();
 
-        if ( isset( $args[4] ) )
+        if ( isset( $args[4] ) ) {
             $fields = $args[4];
-        else
+        } else {
+            /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
             $fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUsers' );
+        }
 
         if ( ! $user = $this->login( $username, $password ) )
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getUsers' );
 
@@ -2149 +2335 @@
         $password   = $args[2];
 
-        if ( isset( $args[3] ) )
+        if ( isset( $args[3] ) ) {
             $fields = $args[3];
-        else
+        } else {
+            /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
             $fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getProfile' );
+        }
 
         if ( ! $user = $this->login( $username, $password ) )
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getProfile' );
 
@@ -2200 +2389 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.editProfile' );
 
@@ -2273 +2463 @@
             return new IXR_Error( 401, __( 'Sorry, you cannot edit this page.' ) );
 
-        do_action('xmlrpc_call', 'wp.getPage');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getPage' );
 
         // If we found the page then format the data.
@@ -2311 +2502 @@
             return new IXR_Error( 401, __( 'Sorry, you cannot edit pages.' ) );
 
-        do_action('xmlrpc_call', 'wp.getPages');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getPages' );
 
         $pages = get_posts( array('post_type' => 'page', 'post_status' => 'any', 'numberposts' => $num_pages) );
@@ -2351 +2543 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'wp.newPage');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.newPage' );
 
         // Mark this as content for a page.
@@ -2379 +2572 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'wp.deletePage');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.deletePage' );
 
         // Get the current page based on the page_id and
@@ -2396 +2590 @@
             return(new IXR_Error(500, __('Failed to delete the page.')));
 
+        /**
+         * Fires after a page has been successfully deleted via XML-RPC.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $page_id ID of the deleted page.
+         * @param array $args    An array of arguments to delete the page.
+         */
         do_action( 'xmlrpc_call_success_wp_deletePage', $page_id, $args );
 
@@ -2421 +2623 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'wp.editPage');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.editPage' );
 
         // Get the page data and make sure it is a page.
@@ -2471 +2674 @@
             return new IXR_Error( 401, __( 'Sorry, you cannot edit pages.' ) );
 
-        do_action('xmlrpc_call', 'wp.getPageList');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getPageList' );
 
         // Get list of pages ids and titles
@@ -2522 +2726 @@
             return(new IXR_Error(401, __('Sorry, you cannot edit posts on this site.')));
 
-        do_action('xmlrpc_call', 'wp.getAuthors');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getAuthors' );
 
         $authors = array();
@@ -2557 +2762 @@
             return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts on this site in order to view tags.' ) );
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getKeywords' );
 
@@ -2596 +2802 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'wp.newCategory');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.newCategory' );
 
         // Make sure the user is allowed to add a category.
@@ -2633 +2840 @@
         }
 
+        /**
+         * Fires after a new category has been successfully created via XML-RPC.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $cat_id ID of the new category.
+         * @param array $args   An array of new category arguments.
+         */
         do_action( 'xmlrpc_call_success_wp_newCategory', $cat_id, $args );
 
@@ -2657 +2872 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'wp.deleteCategory');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.deleteCategory' );
 
         if ( !current_user_can('manage_categories') )
@@ -2664 +2880 @@
         $status = wp_delete_term( $category_id, 'category' );
 
-        if( true == $status )
+        if ( true == $status ) {
+            /**
+             * Fires after a category has been successfully deleted via XML-RPC.
+             *
+             * @since 3.4.0
+             *
+             * @param int   $category_id ID of the deleted category.
+             * @param array $args        An array of arguments to delete the category.
+             */
             do_action( 'xmlrpc_call_success_wp_deleteCategory', $category_id, $args );
+        }
 
         return $status;
@@ -2693 +2918 @@
             return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts to this site in order to view categories.' ) );
 
-        do_action('xmlrpc_call', 'wp.suggestCategories');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.suggestCategories' );
 
         $category_suggestions = array();
@@ -2729 +2955 @@
             return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) );
 
-        do_action('xmlrpc_call', 'wp.getComment');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getComment' );
 
         if ( ! $comment = get_comment($comment_id) )
@@ -2770 +2997 @@
             return new IXR_Error( 401, __( 'Sorry, you cannot edit comments.' ) );
 
-        do_action('xmlrpc_call', 'wp.getComments');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getComments' );
 
         if ( isset($struct['status']) )
@@ -2836 +3064 @@
             return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) );
 
-        do_action('xmlrpc_call', 'wp.deleteComment');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.deleteComment' );
 
         $status = wp_delete_comment( $comment_ID );
 
-        if( true == $status )
+        if ( true == $status ) {
+            /**
+             * Fires after a comment has been successfully deleted via XML-RPC.
+             *
+             * @since 3.4.0
+             *
+             * @param int   $comment_ID ID of the deleted comment.
+             * @param array $args       An array of arguments to delete the comment.
+             */
             do_action( 'xmlrpc_call_success_wp_deleteComment', $comment_ID, $args );
+        }
 
         return $status;
@@ -2891 +3129 @@
             return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) );
 
-        do_action('xmlrpc_call', 'wp.editComment');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.editComment' );
 
         if ( isset($content_struct['status']) ) {
@@ -2932 +3171 @@
             return new IXR_Error(500, __('Sorry, the comment could not be edited. Something wrong happened.'));
 
+        /**
+         * Fires after a comment has been successfully updated via XML-RPC.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $comment_ID ID of the updated comment.
+         * @param array $args       An array of arguments to update the comment.
+         */
         do_action( 'xmlrpc_call_success_wp_editComment', $comment_ID, $args );
 
@@ -2956 +3203 @@
         $content_struct = $args[4];
 
-        $allow_anon = apply_filters('xmlrpc_allow_anonymous_comments', false);
+        /**
+         * Filter whether to allow anonymous comments over XML-RPC.
+         *
+         * @since 2.7.0
+         *
+         * @param bool $allow Whether to allow anonymous commenting via XML-RPC.
+         *                    Default false.
+         */
+        $allow_anon = apply_filters( 'xmlrpc_allow_anonymous_comments', false );
 
         $user = $this->login($username, $password);
@@ -3015 +3270 @@
         $comment['comment_content'] =  isset($content_struct['content']) ? $content_struct['content'] : null;
 
-        do_action('xmlrpc_call', 'wp.newComment');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.newComment' );
 
         $comment_ID = wp_new_comment( $comment );
 
+        /**
+         * Fires after a new comment has been successfully created via XML-RPC.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $comment_ID ID of the new comment.
+         * @param array $args       An array of new comment arguments.
+         */
         do_action( 'xmlrpc_call_success_wp_newComment', $comment_ID, $args );
 
@@ -3045 +3309 @@
             return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) );
 
-        do_action('xmlrpc_call', 'wp.getCommentStatusList');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getCommentStatusList' );
 
         return get_comment_statuses();
@@ -3072 +3337 @@
             return new IXR_Error( 403, __( 'You are not allowed access to details about comments.' ) );
 
-        do_action('xmlrpc_call', 'wp.getCommentCount');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getCommentCount' );
 
         $count = wp_count_comments( $post_id );
@@ -3104 +3370 @@
             return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) );
 
-        do_action('xmlrpc_call', 'wp.getPostStatusList');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getPostStatusList' );
 
         return get_post_statuses();
@@ -3130 +3397 @@
             return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) );
 
-        do_action('xmlrpc_call', 'wp.getPageStatusList');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getPageStatusList' );
 
         return get_page_statuses();
@@ -3287 +3555 @@
             return new IXR_Error( 403, __( 'You do not have permission to upload files.' ) );
 
-        do_action('xmlrpc_call', 'wp.getMediaItem');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getMediaItem' );
 
         if ( ! $attachment = get_post($attachment_id) )
@@ -3332 +3601 @@
             return new IXR_Error( 401, __( 'You do not have permission to upload files.' ) );
 
-        do_action('xmlrpc_call', 'wp.getMediaLibrary');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'wp.getMediaLibrary' );
 
         $parent_id = ( isset($struct['parent_id']) ) ? absint($struct['parent_id']) : '' ;
@@ -3373 +3643 @@
             return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) );
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getPostFormats' );
 
@@ -3428 +3699 @@
         $post_type_name = $args[3];
 
-        if ( isset( $args[4] ) )
+        if ( isset( $args[4] ) ) {
             $fields = $args[4];
-        else
+        } else {
+            /**
+             * Filter the default query fields used by the given XML-RPC method.
+             *
+             * @since 3.4.0
+             *
+             * @param array  $fields An array of post type query fields for the given method.
+             * @param string $method The method name.
+             */
             $fields = apply_filters( 'xmlrpc_default_posttype_fields', array( 'labels', 'cap', 'taxonomies' ), 'wp.getPostType' );
+        }
 
         if ( !$user = $this->login( $username, $password ) )
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getPostType' );
 
@@ -3474 +3755 @@
         $filter             = isset( $args[3] ) ? $args[3] : array( 'public' => true );
 
-        if ( isset( $args[4] ) )
+        if ( isset( $args[4] ) ) {
             $fields = $args[4];
-        else
+        } else {
+            /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
             $fields = apply_filters( 'xmlrpc_default_posttype_fields', array( 'labels', 'cap', 'taxonomies' ), 'wp.getPostTypes' );
+        }
 
         if ( ! $user = $this->login( $username, $password ) )
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getPostTypes' );
 
@@ -3528 +3812 @@
         $post_id    = (int) $args[3];
 
-        if ( isset( $args[4] ) )
+        if ( isset( $args[4] ) ) {
             $fields = $args[4];
-        else
+        } else {
+            /**
+             * Filter the default revision query fields used by the given XML-RPC method.
+             *
+             * @since 3.5.0
+             *
+             * @param array  $field  An array of revision query fields.
+             * @param string $method The method name.
+             */
             $fields = apply_filters( 'xmlrpc_default_revision_fields', array( 'post_date', 'post_date_gmt' ), 'wp.getRevisions' );
+        }
 
         if ( ! $user = $this->login( $username, $password ) )
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.getRevisions' );
 
@@ -3597 +3891 @@
             return $this->error;
 
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
         do_action( 'xmlrpc_call', 'wp.restoreRevision' );
 
@@ -3646 +3941 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'blogger.getUsersBlogs');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'blogger.getUsersBlogs' );
 
         $is_admin = current_user_can('manage_options');
@@ -3713 +4009 @@
             return new IXR_Error( 401, __( 'Sorry, you do not have access to user data on this site.' ) );
 
-        do_action('xmlrpc_call', 'blogger.getUserInfo');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'blogger.getUserInfo' );
 
         $struct = array(
@@ -3752 +4049 @@
             return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
 
-        do_action('xmlrpc_call', 'blogger.getPost');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'blogger.getPost' );
 
         $categories = implode(',', wp_get_post_categories($post_ID));
@@ -3797 +4095 @@
             return new IXR_Error( 401, __( 'Sorry, you cannot edit posts on this site.' ) );
 
-        do_action('xmlrpc_call', 'blogger.getRecentPosts');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'blogger.getRecentPosts' );
 
         $posts_list = wp_get_recent_posts( $query );
@@ -3875 +4174 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'blogger.newPost');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'blogger.newPost' );
 
         $cap = ($publish) ? 'publish_posts' : 'edit_posts';
@@ -3903 +4203 @@
         $this->attach_uploads( $post_ID, $post_content );
 
+        /**
+         * Fires after a new post has been successfully created via the XML-RPC Blogger API.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $post_ID ID of the new post.
+         * @param array $args    An array of new post arguments.
+         */
         do_action( 'xmlrpc_call_success_blogger_newPost', $post_ID, $args );
 
@@ -3929 +4237 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'blogger.editPost');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'blogger.editPost' );
 
         $actual_post = get_post($post_ID,ARRAY_A);
@@ -3959 +4268 @@
         $this->attach_uploads( $ID, $post_content );
 
+        /**
+         * Fires after a post has been successfully updated via the XML-RPC Blogger API.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $post_ID ID of the updated post.
+         * @param array $args    An array of arguments for the post to edit.
+         */
         do_action( 'xmlrpc_call_success_blogger_editPost', $post_ID, $args );
 
@@ -3983 +4300 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'blogger.deletePost');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'blogger.deletePost' );
 
         $actual_post = get_post($post_ID,ARRAY_A);
@@ -3998 +4316 @@
             return new IXR_Error(500, __('For some strange yet very annoying reason, this post could not be deleted.'));
 
+        /**
+         * Fires after a post has been successfully deleted via the XML-RPC Blogger API.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $post_ID ID of the deleted post.
+         * @param array $args    An array of arguments to delete the post.
+         */
         do_action( 'xmlrpc_call_success_blogger_deletePost', $post_ID, $args );
 
@@ -4054 +4380 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'metaWeblog.newPost');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'metaWeblog.newPost' );
 
         $page_template = '';
@@ -4308 +4635 @@
             return new IXR_Error(500, __('Sorry, your entry could not be posted. Something wrong happened.'));
 
+        /**
+         * Fires after a new post has been successfully created via the XML-RPC MovableType API.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $post_ID ID of the new post.
+         * @param array $args    An array of arguments to create the new post.
+         */
         do_action( 'xmlrpc_call_success_mw_newPost', $post_ID, $args );
 
@@ -4373 +4708 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'metaWeblog.editPost');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'metaWeblog.editPost' );
 
         $postdata = get_post( $post_ID, ARRAY_A );
@@ -4616 +4952 @@
             set_post_format( $post_ID, $content_struct['wp_post_format'] );
 
+        /**
+         * Fires after a post has been successfully updated via the XML-RPC MovableType API.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $post_ID ID of the updated post.
+         * @param array $args    An array of arguments to update the post.
+         */
         do_action( 'xmlrpc_call_success_mw_editPost', $post_ID, $args );
 
@@ -4647 +4991 @@
             return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
 
-        do_action('xmlrpc_call', 'metaWeblog.getPost');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'metaWeblog.getPost' );
 
         if ($postdata['post_date'] != '') {
@@ -4771 +5116 @@
             return new IXR_Error( 401, __( 'Sorry, you cannot edit posts on this site.' ) );
 
-        do_action('xmlrpc_call', 'metaWeblog.getRecentPosts');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'metaWeblog.getRecentPosts' );
 
         $posts_list = wp_get_recent_posts( $query );
@@ -4886 +5232 @@
             return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts on this site in order to view categories.' ) );
 
-        do_action('xmlrpc_call', 'metaWeblog.getCategories');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'metaWeblog.getCategories' );
 
         $categories_struct = array();
@@ -4934 +5281 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'metaWeblog.newMediaObject');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'metaWeblog.newMediaObject' );
 
         if ( !current_user_can('upload_files') ) {
@@ -4941 +5289 @@
         }
 
-        if ( $upload_err = apply_filters( 'pre_upload_error', false ) )
-            return new IXR_Error(500, $upload_err);
+        /**
+         * Filter whether to preempt the XML-RPC media upload.
+         *
+         * Passing a truthy value will effectively short-circuit the media upload,
+         * returning that value as a 500 error instead.
+         *
+         * @since 2.1.0
+         *
+         * @param bool $error Whether to pre-empt the media upload. Default false.
+         */
+        if ( $upload_err = apply_filters( 'pre_upload_error', false ) ) {
+            return new IXR_Error( 500, $upload_err );
+        }
 
         if ( !empty($data['overwrite']) && ($data['overwrite'] == true) ) {
@@ -4988 +5347 @@
         wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $upload['file'] ) );
 
+        /**
+         * Fires after a new attachment has been added via the XML-RPC MovableType API.
+         *
+         * @since 3.4.0
+         *
+         * @param int   $id   ID of the new attachment.
+         * @param array $args An array of arguments to add the attachment.
+         */
         do_action( 'xmlrpc_call_success_mw_newMediaObject', $id, $args );
 
@@ -5028 +5395 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'mt.getRecentPostTitles');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'mt.getRecentPostTitles' );
 
         $posts_list = wp_get_recent_posts( $query );
@@ -5087 +5455 @@
             return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts on this site in order to view categories.' ) );
 
-        do_action('xmlrpc_call', 'mt.getCategoryList');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'mt.getCategoryList' );
 
         $categories_struct = array();
@@ -5128 +5497 @@
             return new IXR_Error( 401, __( 'Sorry, you can not edit this post.' ) );
 
-        do_action('xmlrpc_call', 'mt.getPostCategories');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'mt.getPostCategories' );
 
         $categories = array();
@@ -5166 +5536 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'mt.setPostCategories');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'mt.setPostCategories' );
 
         if ( ! get_post( $post_ID ) )
@@ -5194 +5565 @@
     function mt_supportedMethods($args) {
 
-        do_action('xmlrpc_call', 'mt.supportedMethods');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'mt.supportedMethods' );
 
         $supported_methods = array();
@@ -5212 +5584 @@
      */
     function mt_supportedTextFilters($args) {
-        do_action('xmlrpc_call', 'mt.supportedTextFilters');
-        return apply_filters('xmlrpc_text_filters', array());
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'mt.supportedTextFilters' );
+
+        /**
+         * Filter the MoveableType text filters list for XML-RPC.
+         *
+         * @since 2.2.0
+         *
+         * @param array $filters An array of text filters.
+         */
+        return apply_filters( 'xmlrpc_text_filters', array() );
     }
 
@@ -5230 +5611 @@
         $post_ID = intval($args);
 
-        do_action('xmlrpc_call', 'mt.getTrackbackPings');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'mt.getTrackbackPings' );
 
         $actual_post = get_post($post_ID, ARRAY_A);
@@ -5277 +5659 @@
             return $this->error;
 
-        do_action('xmlrpc_call', 'mt.publishPost');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'mt.publishPost' );
 
         $postdata = get_post($post_ID, ARRAY_A);
@@ -5313 +5696 @@
         global $wpdb;
 
-        do_action('xmlrpc_call', 'pingback.ping');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'pingback.ping' );
 
         $this->escape($args);
@@ -5326 +5710 @@
         $pagelinkedto = str_replace('&', '&', $pagelinkedto);
 
+        /**
+         * Filter the pingback source URI.
+         *
+         * @since 3.6.0
+         *
+         * @param string $pagelinkedfrom URI of the page linked from.
+         * @param string $pagelinkedto   URI of the page linked to.
+         */
         $pagelinkedfrom = apply_filters( 'pingback_ping_source_uri', $pagelinkedfrom, $pagelinkedto );
+
         if ( ! $pagelinkedfrom )
             return $this->pingback_error( 0, __( 'A valid URL was not provided.' ) );
@@ -5405 +5798 @@
 
         if ( !$linea )
-            return $this->pingback_error( 16, __( 'The source URL does not exist.' ) );
-
-        $linea = apply_filters('pre_remote_source', $linea, $pagelinkedto);
+            return $this->pingback_error( 16, __( 'The source URL does not exist.' ) );
+
+        /**
+         * Filter the pingback remote source.
+         *
+         * @since 2.5.0
+         *
+         * @param string $linea        Response object for the page linked from.
+         * @param string $pagelinkedto URL of the page linked to.
+         */
+        $linea = apply_filters( 'pre_remote_source', $linea, $pagelinkedto );
 
         // Work around bug in strip_tags():
@@ -5472 +5873 @@
 
         $comment_ID = wp_new_comment($commentdata);
-        do_action('pingback_post', $comment_ID);
+
+        /**
+         * Fires after a post pingback has been sent.
+         *
+         * @since 0.71
+         *
+         * @param int $comment_ID Comment ID.
+         */
+        do_action( 'pingback_post', $comment_ID );
 
         return sprintf(__('Pingback from %1$s to %2$s registered. Keep the web talking! :-)'), $pagelinkedfrom, $pagelinkedto);
@@ -5491 +5900 @@
         global $wpdb;
 
-        do_action('xmlrpc_call', 'pingback.extensions.getPingbacks');
+        /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+        do_action( 'xmlrpc_call', 'pingback.extensions.getPingbacks' );
 
         $this->escape($args);
@@ -5525 +5935 @@
 
     protected function pingback_error( $code, $message ) {
+        /**
+         * Filter the XML-RPC pingback error return.
+         *
+         * @since 3.5.1
+         *
+         * @param IXR_Error $error An IXR_Error object containing the error code and message.
+         */
         return apply_filters( 'xmlrpc_pingback_error', new IXR_Error( $code, $message ) );
     }