X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f5fcdc7994bb67cce809bc4777944ae8b7fad4a4..dc1231b7312fbdca99e9e887cc2bb35a28f85cdc:/wp-includes/class-wp-xmlrpc-server.php diff --git a/wp-includes/class-wp-xmlrpc-server.php b/wp-includes/class-wp-xmlrpc-server.php index aac66314..9121c07a 100644 --- a/wp-includes/class-wp-xmlrpc-server.php +++ b/wp-includes/class-wp-xmlrpc-server.php @@ -22,17 +22,29 @@ */ class wp_xmlrpc_server extends IXR_Server { /** + * Methods. + * + * @access public * @var array */ public $methods; + /** + * Blog options. + * + * @access public * @var array */ public $blog_options; + /** + * IXR_Error instance. + * + * @access public * @var IXR_Error */ public $error; + /** * Register all of the XMLRPC methods that XMLRPC server understands. * @@ -158,7 +170,7 @@ class wp_xmlrpc_server extends IXR_Server { * * @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 ) { if ( '_multisite_getUsersBlogs' === $name ) { @@ -167,6 +179,9 @@ class wp_xmlrpc_server extends IXR_Server { return false; } + /** + * @access public + */ public function serve_request() { $this->IXR_Server($this->methods); } @@ -176,10 +191,9 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method Parameters. - * @return string + * @return string Hello string response. */ - public function sayHello($args) { + public function sayHello() { return 'Hello!'; } @@ -188,10 +202,15 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method Parameters. - * @return int + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $number1 A number to add. + * @type int $number2 A second number to add. + * } + * @return int Sum of the two given numbers. */ - public function addTwoNumbers($args) { + public function addTwoNumbers( $args ) { $number1 = $args[0]; $number2 = $args[1]; return $number1 + $number2; @@ -275,7 +294,8 @@ class wp_xmlrpc_server extends IXR_Server { * @since 1.5.2 * * @param string|array $data Escape single string or array of strings. - * @return string|array Type matches $data and sanitized for the database. + * @return string|void Returns with string is passed, alters by-reference + * when array is passed. */ public function escape( &$data ) { if ( ! is_array( $data ) ) @@ -351,9 +371,11 @@ class wp_xmlrpc_server extends IXR_Server { /** * Set up blog options property. * - * Passes property through 'xmlrpc_blog_options' filter. + * Passes property through {@see 'xmlrpc_blog_options'} filter. * * @since 2.6.0 + * + * @global string $wp_version */ public function initialise_blog_option_info() { global $wp_version; @@ -493,7 +515,7 @@ class wp_xmlrpc_server extends IXR_Server { 'option' => 'default_comment_status' ), 'default_ping_status' => array( - 'desc' => __( 'Allow link notifications from other blogs (pingbacks and trackbacks)' ), + 'desc' => __( 'Allow link notifications from other blogs (pingbacks and trackbacks) on new articles' ), 'readonly' => false, 'option' => 'default_ping_status' ) @@ -514,9 +536,12 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.6.0 * - * @param array $args Method parameters. Contains: - * - username - * - password + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type string $username Username. + * @type string $password Password. + * } * @return array|IXR_Error Array contains: * - 'isAdmin' * - 'url' @@ -548,7 +573,7 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param method $name The method name. + * @param string $name The method name. */ do_action( 'xmlrpc_call', 'wp.getUsersBlogs' ); @@ -556,7 +581,7 @@ class wp_xmlrpc_server extends IXR_Server { $struct = array(); foreach ( $blogs as $blog ) { - // Don't include blogs that aren't hosted at this site + // Don't include blogs that aren't hosted at this site. if ( $blog->site_id != get_current_site()->id ) continue; @@ -584,10 +609,11 @@ class wp_xmlrpc_server extends IXR_Server { * Checks if the method received at least the minimum number of arguments. * * @since 3.4.0 + * @access protected * * @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. + * @param int $count Minimum number of arguments. + * @return bool if `$args` contains at least $count arguments. */ protected function minimum_args( $args, $count ) { if ( count( $args ) < $count ) { @@ -603,9 +629,9 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param object $taxonomy The unprepared taxonomy data - * @param array $fields The subset of taxonomy fields to return - * @return array The prepared taxonomy data + * @param object $taxonomy The unprepared taxonomy data. + * @param array $fields The subset of taxonomy fields to return. + * @return array The prepared taxonomy data. */ protected function _prepare_taxonomy( $taxonomy, $fields ) { $_taxonomy = array( @@ -646,12 +672,12 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param array|object $term The unprepared term data - * @return array The prepared term data + * @param array|object $term The unprepared term data. + * @return array The prepared term data. */ protected function _prepare_term( $term ) { $_term = $term; - if ( ! is_array( $_term) ) + if ( ! is_array( $_term ) ) $_term = get_object_vars( $_term ); // For integers which may be larger than XML-RPC supports ensure we return strings. @@ -679,8 +705,8 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param string $date - * @return IXR_Date + * @param string $date Date string to convert. + * @return IXR_Date IXR_Date object. */ protected function _convert_date( $date ) { if ( $date === '0000-00-00 00:00:00' ) { @@ -694,9 +720,9 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param string $date_gmt - * @param string $date - * @return IXR_Date + * @param string $date_gmt WordPress GMT date string. + * @param string $date Date string. + * @return IXR_Date IXR_Date object. */ protected function _convert_date_gmt( $date_gmt, $date ) { if ( $date !== '0000-00-00 00:00:00' && $date_gmt === '0000-00-00 00:00:00' ) { @@ -710,15 +736,15 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param array $post The unprepared post data - * @param array $fields The subset of post type fields to return - * @return array The prepared post data + * @param array $post The unprepared post data. + * @param array $fields The subset of post type fields to return. + * @return array The prepared post data. */ protected function _prepare_post( $post, $fields ) { - // holds the data for this post. built up based on $fields + // Holds the data for this post. built up based on $fields. $_post = array( 'post_id' => strval( $post['ID'] ) ); - // prepare common post fields + // Prepare common post fields. $post_fields = array( 'post_title' => $post['post_title'], 'post_date' => $this->_convert_date( $post['post_date'] ), @@ -742,7 +768,7 @@ class wp_xmlrpc_server extends IXR_Server { 'sticky' => ( $post['post_type'] === 'post' && is_sticky( $post['ID'] ) ), ); - // Thumbnail + // Thumbnail. $post_fields['post_thumbnail'] = array(); $thumbnail_id = get_post_thumbnail_id( $post['ID'] ); if ( $thumbnail_id ) { @@ -750,16 +776,16 @@ class wp_xmlrpc_server extends IXR_Server { $post_fields['post_thumbnail'] = $this->_prepare_media_item( get_post( $thumbnail_id ), $thumbnail_size ); } - // Consider future posts as published + // Consider future posts as published. if ( $post_fields['post_status'] === 'future' ) $post_fields['post_status'] = 'publish'; - // Fill in blank post format + // Fill in blank post format. $post_fields['post_format'] = get_post_format( $post['ID'] ); if ( empty( $post_fields['post_format'] ) ) $post_fields['post_format'] = 'standard'; - // Merge requested $post_fields fields into $_post + // Merge requested $post_fields fields into $_post. if ( in_array( 'post', $fields ) ) { $_post = array_merge( $_post, $post_fields ); } else { @@ -809,9 +835,9 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param object $post_type Post type object - * @param array $fields The subset of post fields to return - * @return array The prepared post type data + * @param object $post_type Post type object. + * @param array $fields The subset of post fields to return. + * @return array The prepared post type data. */ protected function _prepare_post_type( $post_type, $fields ) { $_post_type = array( @@ -859,9 +885,9 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param object $media_item The unprepared media item data - * @param string $thumbnail_size The image size to use for the thumbnail URL - * @return array The prepared media item data + * @param object $media_item The unprepared media item data. + * @param string $thumbnail_size The image size to use for the thumbnail URL. + * @return array The prepared media item data. */ protected function _prepare_media_item( $media_item, $thumbnail_size = 'thumbnail' ) { $_media_item = array( @@ -898,8 +924,8 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param object $page The unprepared page data - * @return array The prepared page data + * @param object $page The unprepared page data. + * @return array The prepared page data. */ protected function _prepare_page( $page ) { // Get all of the page content and link. @@ -979,8 +1005,8 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param object $comment The unprepared comment data - * @return array The prepared comment data + * @param object $comment The unprepared comment data. + * @return array The prepared comment data. */ protected function _prepare_comment( $comment ) { // Format page date. @@ -1028,9 +1054,9 @@ class wp_xmlrpc_server extends IXR_Server { * * @access protected * - * @param WP_User $user The unprepared user object - * @param array $fields The subset of user fields to return - * @return array The prepared user data + * @param WP_User $user The unprepared user object. + * @param array $fields The subset of user fields to return. + * @return array The prepared user data. */ protected function _prepare_user( $user, $fields ) { $_user = array( 'user_id' => strval( $user->ID ) ); @@ -1077,31 +1103,47 @@ class wp_xmlrpc_server extends IXR_Server { * * @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: - * - post_type (default: 'post') - * - post_status (default: 'draft') - * - post_title - * - post_author - * - post_excerpt - * - post_content - * - post_date_gmt | post_date - * - post_format - * - post_password - * - comment_status - can be 'open' | 'closed' - * - ping_status - can be 'open' | 'closed' - * - sticky - * - post_thumbnail - ID of a media item to use as the post thumbnail/featured image - * - custom_fields - array, with each element containing 'key' and 'value' - * - terms - array, with taxonomy names as keys and arrays of term IDs as values - * - terms_names - array, with taxonomy names as keys and arrays of term names as values - * - enclosure - * - any other fields supported by wp_insert_post() - * @return string|IXR_Error post_id + * @link http://en.wikipedia.org/wiki/RSS_enclosure for information on RSS enclosures. + * + * @param array $args { + * Method arguments. Note: top-level arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type array $content_struct { + * Content struct for adding a new post. See wp_insert_post() for information on + * additional post fields + * + * @type string $post_type Post type. Default 'post'. + * @type string $post_status Post status. Default 'draft' + * @type string $post_title Post title. + * @type int $post_author Post author ID. + * @type string $post_excerpt Post excerpt. + * @type string $post_content Post content. + * @type string $post_date_gmt Post date in GMT. + * @type string $post_date Post date. + * @type string $post_password Post password (20-character limit). + * @type string $comment_status Post comment enabled status. Accepts 'open' or 'closed'. + * @type string $ping_status Post ping status. Accepts 'open' or 'closed'. + * @type bool $sticky Whether the post should be sticky. Automatically false if + * `$post_status` is 'private'. + * @type int $post_thumbnail ID of an image to use as the post thumbnail/featured image. + * @type array $custom_fields Array of meta key/value pairs to add to the post. + * @type array $terms Associative array with taxonomy names as keys and arrays + * of term IDs as values. + * @type array $terms_names Associative array with taxonomy names as keys and arrays + * of term names as values. + * @type array $enclosure { + * Array of feed enclosure data to add to post meta. + * + * @type string $url URL for the feed enclosure. + * @type int $length Size in bytes of the enclosure. + * @type string $type Mime-type for the enclosure. + * } + * } + * } + * @return int|IXR_Error Post ID on success, IXR_Error instance otherwise. */ public function wp_newPost( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) @@ -1150,18 +1192,6 @@ class wp_xmlrpc_server extends IXR_Server { return $count > 1; } - private function _validate_boolean( $var ) { - if ( is_bool( $var ) ) { - return $var; - } - - if ( is_string( $var ) && 'false' === strtolower( $var ) ) { - return false; - } - - return (bool) $var; - } - /** * Encapsulate the logic for sticking a post * and determining if the user has permission to do so @@ -1191,7 +1221,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 401, __( 'Sorry, you are not allowed to stick this post.' ) ); } - $sticky = $this->_validate_boolean( $post_data['sticky'] ); + $sticky = wp_validate_boolean( $post_data['sticky'] ); if ( $sticky ) { stick_post( $post_data['ID'] ); } else { @@ -1201,13 +1231,16 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * Helper method for wp_newPost and wp_editPost, containing shared logic. + * Helper method for wp_newPost() and wp_editPost(), containing shared logic. * * @since 3.4.0 - * @uses wp_insert_post() + * @access protected + * + * @see wp_insert_post() * - * @param WP_User $user The post author if post_author isn't set in $content_struct. + * @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 ) { $defaults = array( 'post_status' => 'draft', 'post_type' => 'post', 'post_author' => 0, @@ -1274,9 +1307,9 @@ class wp_xmlrpc_server extends IXR_Server { if ( isset( $post_data['ping_status'] ) && $post_data['ping_status'] != 'open' && $post_data['ping_status'] != 'closed' ) unset( $post_data['ping_status'] ); - // Do some timestamp voodoo + // Do some timestamp voodoo. if ( ! empty( $post_data['post_date_gmt'] ) ) { - // We know this is supposed to be GMT, so we're going to slap that Z on there by force + // We know this is supposed to be GMT, so we're going to slap that Z on there by force. $dateCreated = rtrim( $post_data['post_date_gmt']->getIso(), 'Z' ) . 'Z'; } elseif ( ! empty( $post_data['post_date'] ) ) { $dateCreated = $post_data['post_date']->getIso(); @@ -1299,7 +1332,7 @@ class wp_xmlrpc_server extends IXR_Server { } if ( isset( $post_data['post_thumbnail'] ) ) { - // empty value deletes, non-empty value adds/updates + // empty value deletes, non-empty value adds/updates. if ( ! $post_data['post_thumbnail'] ) delete_post_thumbnail( $post_ID ); elseif ( ! get_post( absint( $post_data['post_thumbnail'] ) ) ) @@ -1314,14 +1347,14 @@ class wp_xmlrpc_server extends IXR_Server { if ( isset( $post_data['terms'] ) || isset( $post_data['terms_names'] ) ) { $post_type_taxonomies = get_object_taxonomies( $post_data['post_type'], 'objects' ); - // accumulate term IDs from terms and terms_names + // Accumulate term IDs from terms and terms_names. $terms = array(); - // first validate the terms specified by ID + // First validate the terms specified by ID. if ( isset( $post_data['terms'] ) && is_array( $post_data['terms'] ) ) { $taxonomies = array_keys( $post_data['terms'] ); - // validating term ids + // Validating term ids. foreach ( $taxonomies as $taxonomy ) { if ( ! array_key_exists( $taxonomy , $post_type_taxonomies ) ) return new IXR_Error( 401, __( 'Sorry, one of the given taxonomies is not supported by the post type.' ) ); @@ -1342,7 +1375,7 @@ class wp_xmlrpc_server extends IXR_Server { } } - // now validate terms specified by name + // Now validate terms specified by name. if ( isset( $post_data['terms_names'] ) && is_array( $post_data['terms_names'] ) ) { $taxonomies = array_keys( $post_data['terms_names'] ); @@ -1353,15 +1386,18 @@ class wp_xmlrpc_server extends IXR_Server { if ( ! current_user_can( $post_type_taxonomies[$taxonomy]->cap->assign_terms ) ) return new IXR_Error( 401, __( 'Sorry, you are not allowed to assign a term to one of the given taxonomies.' ) ); - // for hierarchical taxonomies, we can't assign a term when multiple terms in the hierarchy share the same name + /* + * For hierarchical taxonomies, we can't assign a term when multiple terms + * in the hierarchy share the same name. + */ $ambiguous_terms = array(); if ( is_taxonomy_hierarchical( $taxonomy ) ) { $tax_term_names = get_terms( $taxonomy, array( 'fields' => 'names', 'hide_empty' => false ) ); - // count the number of terms with the same name + // Count the number of terms with the same name. $tax_term_names_count = array_count_values( $tax_term_names ); - // filter out non-ambiguous term names + // Filter out non-ambiguous term names. $ambiguous_tax_term_counts = array_filter( $tax_term_names_count, array( $this, '_is_greater_than_one') ); $ambiguous_terms = array_keys( $ambiguous_tax_term_counts ); @@ -1375,11 +1411,11 @@ class wp_xmlrpc_server extends IXR_Server { $term = get_term_by( 'name', $term_name, $taxonomy ); if ( ! $term ) { - // term doesn't exist, so check that the user is allowed to create new terms + // Term doesn't exist, so check that the user is allowed to create new terms. if ( ! current_user_can( $post_type_taxonomies[$taxonomy]->cap->edit_terms ) ) return new IXR_Error( 401, __( 'Sorry, you are not allowed to add a term to one of the given taxonomies.' ) ); - // create the new term + // Create the new term. $term_info = wp_insert_term( $term_name, $taxonomy ); if ( is_wp_error( $term_info ) ) return new IXR_Error( 500, $term_info->get_error_message() ); @@ -1395,7 +1431,7 @@ class wp_xmlrpc_server extends IXR_Server { $post_data['tax_input'] = $terms; unset( $post_data['terms'], $post_data['terms_names'] ); } else { - // do not allow direct submission of 'tax_input', clients must use 'terms' and/or 'terms_names' + // Do not allow direct submission of 'tax_input', clients must use 'terms' and/or 'terms_names'. unset( $post_data['tax_input'], $post_data['post_category'], $post_data['tags_input'] ); } @@ -1408,7 +1444,7 @@ class wp_xmlrpc_server extends IXR_Server { unset( $post_data['post_format'] ); } - // Handle enclosures + // Handle enclosures. $enclosure = isset( $post_data['enclosure'] ) ? $post_data['enclosure'] : null; $this->add_enclosure_if_new( $post_ID, $enclosure ); @@ -1442,13 +1478,16 @@ class wp_xmlrpc_server extends IXR_Server { * * @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 arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type int $post_id Post ID. + * @type array $content_struct Extra content arguments. + * } + * @return true|IXR_Error True on success, IXR_Error on failure. */ public function wp_editPost( $args ) { if ( ! $this->minimum_args( $args, 5 ) ) @@ -1479,11 +1518,13 @@ class wp_xmlrpc_server extends IXR_Server { } } - // convert the date field back to IXR form + // Convert the date field back to IXR form. $post['post_date'] = $this->_convert_date( $post['post_date'] ); - // ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct, - // since _insert_post will ignore the non-GMT date if the GMT date is set + /* + * Ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct, + * since _insert_post() will ignore the non-GMT date if the GMT date is set. + */ if ( $post['post_date_gmt'] == '0000-00-00 00:00:00' || isset( $content_struct['post_date'] ) ) unset( $post['post_date_gmt'] ); else @@ -1504,13 +1545,17 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @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 + * @see wp_delete_post() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type int $post_id Post ID. + * } + * @return true|IXR_Error True on success, IXR_Error instance on failure. */ public function wp_deletePost( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) @@ -1557,13 +1602,17 @@ class wp_xmlrpc_server extends IXR_Server { * groups are 'post' (all basic fields), 'taxonomies', 'custom_fields', * and 'enclosure'. * - * @uses get_post() - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - int $post_id - * - array $fields optional + * @see get_post() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type int $post_id Post ID. + * @type array $fields The subset of post type fields to return. + * } * @return array|IXR_Error Array contains (based on $fields parameter): * - 'post_id' * - 'post_title' @@ -1594,9 +1643,9 @@ class wp_xmlrpc_server extends IXR_Server { $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] ) ) { $fields = $args[4]; @@ -1606,7 +1655,7 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @param array $fields Array of post fields. + * @param array $fields Array of post fields. Default array contains 'post', 'terms', and 'custom_fields'. * @param string $method Method name. */ $fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPost' ); @@ -1634,23 +1683,21 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * The optional $filter parameter modifies the query used to retrieve posts. - * Accepted keys are 'post_type', 'post_status', 'number', 'offset', - * 'orderby', and 'order'. - * - * The optional $fields parameter specifies what fields will be included - * in the response array. - * - * @uses wp_get_recent_posts() - * @see wp_getPost() for more on $fields - * @see get_posts() for more on $filter values - * - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - array $filter optional - * - array $fields optional + * @see wp_get_recent_posts() + * @see wp_getPost() for more on `$fields` + * @see get_posts() for more on `$filter` values + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type array $filter Optional. Modifies the query used to retrieve posts. Accepts 'post_type', + * 'post_status', 'number', 'offset', 'orderby', and 'order'. + * Default empty array. + * @type array $fields Optional. The subset of post type fields to return in the response array. + * } * @return array|IXR_Error Array contains a collection of posts. */ public function wp_getPosts( $args ) { @@ -1659,9 +1706,9 @@ class wp_xmlrpc_server extends IXR_Server { $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] ) ) { $fields = $args[4]; @@ -1716,7 +1763,7 @@ class wp_xmlrpc_server extends IXR_Server { if ( ! $posts_list ) return array(); - // holds all the posts data + // Holds all the posts data. $struct = array(); foreach ( $posts_list as $post ) { @@ -1734,20 +1781,19 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses wp_insert_term() - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - array $content_struct - * The $content_struct must contain: - * - 'name' - * - 'taxonomy' - * Also, it can optionally contain: - * - 'parent' - * - 'description' - * - 'slug' - * @return string|IXR_Error term_id + * @see wp_insert_term() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type array $content_struct Content struct for adding a new term. The struct must contain + * the term 'name' and 'taxonomy'. Optional accepted values include + * 'parent', 'description', and 'slug'. + * } + * @return int|IXR_Error The term ID on success, or an IXR_Error object on failure. */ public function wp_newTerm( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) @@ -1755,9 +1801,9 @@ class wp_xmlrpc_server extends IXR_Server { $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 ) ) return $this->error; @@ -1820,21 +1866,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses wp_update_term() - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - string $term_id - * - array $content_struct - * The $content_struct must contain: - * - 'taxonomy' - * Also, it can optionally contain: - * - 'name' - * - 'parent' - * - 'description' - * - 'slug' - * @return bool|IXR_Error True, on success. + * @see wp_update_term() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type int $term_id Term ID. + * @type array $content_struct Content struct for editing a term. The struct must contain the + * term ''taxonomy'. Optional accepted values include 'name', 'parent', + * 'description', and 'slug'. + * } + * @return true|IXR_Error True on success, IXR_Error instance on failure. */ public function wp_editTerm( $args ) { if ( ! $this->minimum_args( $args, 5 ) ) @@ -1842,10 +1887,10 @@ class wp_xmlrpc_server extends IXR_Server { $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 ) ) return $this->error; @@ -1919,14 +1964,18 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @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 + * @see wp_delete_term() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type string $taxnomy_name Taxonomy name. + * @type int $term_id Term ID. + * } + * @return bool|IXR_Error True on success, IXR_Error instance on failure. */ public function wp_deleteTerm( $args ) { if ( ! $this->minimum_args( $args, 5 ) ) @@ -1977,14 +2026,18 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses get_term() - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - string $taxonomy - * - string $term_id - * @return array|IXR_Error Array contains: + * @see get_term() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type string $taxnomy Taxonomy name. + * @type string $term_id Term ID. + * } + * @return array|IXR_Error IXR_Error on failure, array on success, containing: * - 'term_id' * - 'name' * - 'slug' @@ -2039,14 +2092,19 @@ class wp_xmlrpc_server extends IXR_Server { * The optional $filter parameter modifies the query used to retrieve terms. * Accepted keys are 'number', 'offset', 'orderby', 'order', 'hide_empty', and 'search'. * - * @uses get_terms() - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - string $taxonomy - * - array $filter optional - * @return array|IXR_Error terms + * @see get_terms() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type string $taxnomy Taxonomy name. + * @type array $filter Optional. Modifies the query used to retrieve posts. Accepts 'number', + * 'offset', 'orderby', 'order', 'hide_empty', and 'search'. Default empty array. + * } + * @return array|IXR_Error An associative array of terms data on success, IXR_Error instance otherwise. */ public function wp_getTerms( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) @@ -2115,13 +2173,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses get_taxonomy() - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - string $taxonomy - * @return array|IXR_Error (@see get_taxonomy()) + * @see get_taxonomy() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type string $taxnomy Taxonomy name. + * @type array $fields Optional. Array of taxonomy fields to limit to in the return. + * Accepts 'labels', 'cap', 'menu', and 'object_type'. + * Default empty array. + * } + * @return array|IXR_Error An array of taxonomy data on success, IXR_Error instance otherwise. */ public function wp_getTaxonomy( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) @@ -2129,9 +2194,9 @@ class wp_xmlrpc_server extends IXR_Server { $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] ) ) { $fields = $args[4]; @@ -2169,12 +2234,19 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses get_taxonomies() - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * @return array taxonomies + * @see get_taxonomies() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type array $filter Optional. An array of arguments for retrieving taxonomies. + * @type array $fields Optional. The subset of taxonomy fields to return. + * } + * @return array|IXR_Error An associative array of taxonomy data with returned fields determined + * by `$fields`, or an IXR_Error instance on failure. */ public function wp_getTaxonomies( $args ) { if ( ! $this->minimum_args( $args, 3 ) ) @@ -2182,9 +2254,9 @@ class wp_xmlrpc_server extends IXR_Server { $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] ) ) { $fields = $args[4]; @@ -2227,12 +2299,16 @@ class wp_xmlrpc_server extends IXR_Server { * groups are 'basic' and 'all'. * * @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 arguments. Note: arguments must be ordered as documented. + * + * @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' * - 'username' @@ -2253,9 +2329,9 @@ class wp_xmlrpc_server extends IXR_Server { $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] ) ) { $fields = $args[4]; @@ -2283,7 +2359,7 @@ class wp_xmlrpc_server extends IXR_Server { $user_data = get_userdata( $user_id ); if ( ! $user_data ) - return new IXR_Error( 404, __( 'Invalid user ID' ) ); + return new IXR_Error( 404, __( 'Invalid user ID.' ) ); return $this->_prepare_user( $user_data, $fields ); } @@ -2301,12 +2377,15 @@ class wp_xmlrpc_server extends IXR_Server { * @uses get_users() * @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 arguments. Note: arguments must be ordered as documented. + * + * @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 */ public function wp_getUsers( $args ) { @@ -2315,9 +2394,9 @@ class wp_xmlrpc_server extends IXR_Server { $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] ) ) { $fields = $args[4]; @@ -2372,11 +2451,15 @@ class wp_xmlrpc_server extends IXR_Server { * Retrieve information about the requesting user. * * @uses get_userdata() - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - array $fields optional + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * @type array $fields (optional) + * } * @return array|IXR_Error (@see wp_getUser) */ public function wp_getProfile( $args ) { @@ -2385,8 +2468,8 @@ class wp_xmlrpc_server extends IXR_Server { $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( isset( $args[3] ) ) { $fields = $args[3]; @@ -2413,12 +2496,14 @@ class wp_xmlrpc_server extends IXR_Server { * Edit user's profile. * * @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 arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * @type array $content_struct It can optionally contain: * - 'first_name' * - 'last_name' * - 'website' @@ -2426,7 +2511,8 @@ class wp_xmlrpc_server extends IXR_Server { * - 'nickname' * - 'nicename' * - 'bio' - * @return bool|IXR_Error True, on success. + * } + * @return true|IXR_Error True, on success. */ public function wp_editProfile( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) @@ -2489,19 +2575,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. Contains: - * - blog_id (unused) - * - page_id - * - username - * - password + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function wp_getPage( $args ) { + $this->escape( $args ); - $page_id = (int) $args[1]; - $username = $args[2]; - $password = $args[3]; + $page_id = (int) $args[1]; + $username = $args[2]; + $password = $args[3]; if ( !$user = $this->login($username, $password) ) { return $this->error; @@ -2532,19 +2621,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. Contains: - * - blog_id (unused) - * - username - * - password - * - num_pages + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function wp_getPages( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; - $num_pages = isset($args[3]) ? (int) $args[3] : 10; + $username = $args[1]; + $password = $args[2]; + $num_pages = isset($args[3]) ? (int) $args[3] : 10; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -2578,13 +2670,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()} + * @see wp_xmlrpc_server::mw_newPost() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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) ) return $this->error; @@ -2604,15 +2705,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. - * @return bool|IXR_Error True, if success. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function wp_deletePage( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; - $page_id = (int) $args[3]; + $username = $args[1]; + $password = $args[2]; + $page_id = (int) $args[3]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -2653,19 +2761,32 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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) { - // 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]; + public function wp_editPage( $args ) { + // Items will be escaped in mw_editPost. + $page_id = (int) $args[1]; + $username = $args[2]; + $password = $args[3]; + $content = $args[4]; + $publish = $args[5]; - if ( !$user = $this->login($username, $password) ) + $escaped_username = $this->escape( $username ); + $escaped_password = $this->escape( $password ); + + if ( !$user = $this->login( $escaped_username, $escaped_password ) ) { return $this->error; + } /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.editPage' ); @@ -2700,16 +2821,24 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. + * @global wpdb $wpdb + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -2752,15 +2881,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ - public function wp_getAuthors($args) { - - $this->escape($args); + public function wp_getAuthors( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -2788,14 +2922,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ public function wp_getTags( $args ) { $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -2830,15 +2970,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function wp_newCategory( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; - $category = $args[3]; + $username = $args[1]; + $password = $args[2]; + $category = $args[3]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -2899,15 +3046,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function wp_deleteCategory( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; - $category_id = (int) $args[3]; + $username = $args[1]; + $password = $args[2]; + $category_id = (int) $args[3]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -2940,16 +3094,24 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function wp_suggestCategories( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; - $category = $args[3]; - $max_results = (int) $args[4]; + $username = $args[1]; + $password = $args[2]; + $category = $args[3]; + $max_results = (int) $args[4]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -2977,7 +3139,14 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * @type int $comment_id + * } * @return array|IXR_Error */ public function wp_getComment($args) { @@ -3018,15 +3187,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function wp_getComments( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; - $struct = isset( $args[3] ) ? $args[3] : array(); + $username = $args[1]; + $password = $args[2]; + $struct = isset( $args[3] ) ? $args[3] : array(); if ( !$user = $this->login($username, $password) ) return $this->error; @@ -3054,12 +3230,13 @@ class wp_xmlrpc_server extends IXR_Server { if ( isset($struct['number']) ) $number = absint($struct['number']); - $comments = get_comments( array('status' => $status, 'post_id' => $post_id, 'offset' => $offset, 'number' => $number ) ); + $comments = get_comments( array( 'status' => $status, 'post_id' => $post_id, 'offset' => $offset, 'number' => $number ) ); $comments_struct = array(); - - foreach ( $comments as $comment ) { - $comments_struct[] = $this->_prepare_comment( $comment ); + if ( is_array( $comments ) ) { + foreach ( $comments as $comment ) { + $comments_struct[] = $this->_prepare_comment( $comment ); + } } return $comments_struct; @@ -3074,11 +3251,14 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. Contains: - * - blog_id (unused) - * - username - * - password - * - comment_id + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * @type int $comment_ID + * } * @return bool|IXR_Error {@link wp_delete_comment()} */ public function wp_deleteComment($args) { @@ -3105,7 +3285,7 @@ class wp_xmlrpc_server extends IXR_Server { $status = wp_delete_comment( $comment_ID ); - if ( true == $status ) { + if ( $status ) { /** * Fires after a comment has been successfully deleted via XML-RPC. * @@ -3132,20 +3312,23 @@ class wp_xmlrpc_server extends IXR_Server { * - 'author_email' * - 'content' * - 'date_created_gmt' - * - 'status'. Common statuses are 'approve', 'hold', 'spam'. See {@link get_comment_statuses()} for more details + * - 'status'. Common statuses are 'approve', 'hold', 'spam'. See get_comment_statuses() for more details * * @since 2.7.0 * - * @param array $args Contains: - * - blog_id (unused) - * - username - * - password - * - comment_id - * - content_struct - * @return bool|IXR_Error True, on success. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * @type int $comment_ID + * @type array $content_struct + * } + * @return true|IXR_Error True, on success. */ - public function wp_editComment($args) { - $this->escape($args); + public function wp_editComment( $args ) { + $this->escape( $args ); $username = $args[1]; $password = $args[2]; @@ -3224,15 +3407,23 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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()} */ public function wp_newComment($args) { $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]; /** @@ -3327,14 +3518,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ public function wp_getCommentStatusList($args) { $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -3353,11 +3550,18 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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]; $password = $args[2]; @@ -3386,14 +3590,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ public function wp_getPostStatusList( $args ) { $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -3412,14 +3622,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ public function wp_getPageStatusList( $args ) { $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -3438,14 +3654,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.6.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ public function wp_getPageTemplates( $args ) { $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -3464,7 +3686,14 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.6.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * @type array $options + * } * @return array|IXR_Error */ public function wp_getOptions( $args ) { @@ -3517,7 +3746,14 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.6.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * @type array $options + * } * @return array|IXR_Error */ public function wp_setOptions( $args ) { @@ -3554,11 +3790,14 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.1.0 * - * @param array $args Method parameters. Contains: - * - blog_id (unused) - * - username - * - password - * - attachment_id + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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' * - 'parent' @@ -3569,8 +3808,8 @@ class wp_xmlrpc_server extends IXR_Server { * - 'description' * - 'metadata' */ - public function wp_getMediaItem($args) { - $this->escape($args); + public function wp_getMediaItem( $args ) { + $this->escape( $args ); $username = $args[1]; $password = $args[2]; @@ -3601,18 +3840,21 @@ class wp_xmlrpc_server extends IXR_Server { * * The defaults are as follows: * - 'number' - Default is 5. Total number of media items to retrieve. - * - 'offset' - Default is 0. See {@link WP_Query::query()} for more. + * - 'offset' - Default is 0. See WP_Query::query() for more. * - 'parent_id' - Default is ''. The post where the media item is attached. Empty string shows all media items. 0 shows unattached media items. * - 'mime_type' - Default is ''. Filter by mime type (e.g., 'image/jpeg', 'application/pdf') * * @since 3.1.0 * - * @param array $args Method parameters. Contains: - * - blog_id (unused) - * - username - * - password - * - filter - * @return array|IXR_Error Contains a collection of media items. See {@link wp_xmlrpc_server::wp_getMediaItem()} for a description of each item contents + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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 wp_xmlrpc_server::wp_getMediaItem() for a description of each item contents */ public function wp_getMediaLibrary($args) { $this->escape($args); @@ -3646,16 +3888,19 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * Retrieves a list of post formats used by the site - * - * @since 3.1.0 - * - * @param array $args Method parameters. Contains: - * - blog_id (unused) - * - username - * - password - * @return array|IXR_Error - */ + * Retrieves a list of post formats used by the site. + * + * @since 3.1.0 + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } + * @return array|IXR_Error List of post formats, otherwise IXR_Error object. + */ public function wp_getPostFormats( $args ) { $this->escape( $args ); @@ -3696,13 +3941,17 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @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 + * @see get_post_type_object() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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' * - 'description' @@ -3744,12 +3993,12 @@ class wp_xmlrpc_server extends IXR_Server { /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getPostType' ); - if( ! post_type_exists( $post_type_name ) ) + if ( ! post_type_exists( $post_type_name ) ) return new IXR_Error( 403, __( 'Invalid post type' ) ); $post_type = get_post_type_object( $post_type_name ); - if( ! current_user_can( $post_type->cap->edit_posts ) ) + if ( ! current_user_can( $post_type->cap->edit_posts ) ) return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post type.' ) ); return $this->_prepare_post_type( $post_type, $fields ); @@ -3760,13 +4009,17 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses get_post_types() - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - array $filter - * - array $fields + * @see get_post_types() + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * @type array $filter (optional) + * @type array $fields (optional) + * } * @return array|IXR_Error */ public function wp_getPostTypes( $args ) { @@ -3775,9 +4028,9 @@ class wp_xmlrpc_server extends IXR_Server { $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] ) ) { $fields = $args[4]; @@ -3797,7 +4050,7 @@ class wp_xmlrpc_server extends IXR_Server { $struct = array(); foreach( $post_types as $post_type ) { - if( ! current_user_can( $post_type->cap->edit_posts ) ) + if ( ! current_user_can( $post_type->cap->edit_posts ) ) continue; $struct[$post_type->name] = $this->_prepare_post_type( $post_type, $fields ); @@ -3817,12 +4070,15 @@ class wp_xmlrpc_server extends IXR_Server { * @uses wp_get_post_revisions() * @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 arguments. Note: arguments must be ordered as documented. + * + * @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. */ public function wp_getRevisions( $args ) { @@ -3831,9 +4087,9 @@ class wp_xmlrpc_server extends IXR_Server { $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] ) ) { $fields = $args[4]; @@ -3856,7 +4112,7 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.getRevisions' ); if ( ! $post = get_post( $post_id ) ) - return new IXR_Error( 404, __( 'Invalid post ID' ) ); + return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( ! current_user_can( 'edit_post', $post_id ) ) return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts.' ) ); @@ -3893,11 +4149,14 @@ class wp_xmlrpc_server extends IXR_Server { * * @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 arguments. Note: arguments must be ordered as documented. + * + * @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. */ public function wp_restoreRevision( $args ) { @@ -3917,13 +4176,13 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.restoreRevision' ); if ( ! $revision = wp_get_post_revision( $revision_id ) ) - return new IXR_Error( 404, __( 'Invalid post ID' ) ); + return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( wp_is_post_autosave( $revision ) ) - return new IXR_Error( 404, __( 'Invalid post ID' ) ); + return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( ! $post = get_post( $revision->post_parent ) ) - return new IXR_Error( 404, __( 'Invalid post ID' ) ); + return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( ! current_user_can( 'edit_post', $revision->post_parent ) ) return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) ); @@ -3948,7 +4207,13 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ public function blogger_getUsersBlogs($args) { @@ -3958,7 +4223,7 @@ class wp_xmlrpc_server extends IXR_Server { $this->escape($args); $username = $args[1]; - $password = $args[2]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -4017,15 +4282,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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) ) return $this->error; @@ -4052,16 +4322,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function blogger_getPost( $args ) { + $this->escape( $args ); - $post_ID = (int) $args[1]; + $post_ID = (int) $args[1]; $username = $args[2]; - $password = $args[3]; + $password = $args[3]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -4097,16 +4373,24 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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] ) ); else @@ -4178,17 +4462,25 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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) ) return $this->error; @@ -4240,17 +4532,25 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. - * @return bool|IXR_Error true when done. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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 ) ) { return $this->error; @@ -4307,15 +4607,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. - * @return bool|IXR_Error True when post is deleted. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function blogger_deletePost( $args ) { + $this->escape( $args ); - $post_ID = (int) $args[1]; - $username = $args[2]; - $password = $args[3]; + $post_ID = (int) $args[1]; + $username = $args[2]; + $password = $args[3]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -4380,21 +4687,24 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. Contains: - * - blog_id (unused) - * - username - * - password - * - content_struct - * - publish + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * @type array $content_struct + * @type int $publish + * } * @return int|IXR_Error */ public function mw_newPost($args) { $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) ) return $this->error; @@ -4526,7 +4836,7 @@ class wp_xmlrpc_server extends IXR_Server { $comment_status = 'open'; break; default: - $comment_status = get_option('default_comment_status'); + $comment_status = get_default_comment_status( $post_type ); break; } } else { @@ -4539,12 +4849,12 @@ class wp_xmlrpc_server extends IXR_Server { $comment_status = 'open'; break; default: - $comment_status = get_option('default_comment_status'); + $comment_status = get_default_comment_status( $post_type ); break; } } } else { - $comment_status = get_option('default_comment_status'); + $comment_status = get_default_comment_status( $post_type ); } if ( isset($content_struct['mt_allow_pings']) ) { @@ -4557,7 +4867,7 @@ class wp_xmlrpc_server extends IXR_Server { $ping_status = 'open'; break; default: - $ping_status = get_option('default_ping_status'); + $ping_status = get_default_comment_status( $post_type, 'pingback' ); break; } } else { @@ -4569,12 +4879,12 @@ class wp_xmlrpc_server extends IXR_Server { $ping_status = 'open'; break; default: - $ping_status = get_option('default_ping_status'); + $ping_status = get_default_comment_status( $post_type, 'pingback' ); break; } } } else { - $ping_status = get_option('default_ping_status'); + $ping_status = get_default_comment_status( $post_type, 'pingback' ); } if ( $post_more ) @@ -4695,6 +5005,8 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.1.0 * + * @global wpdb $wpdb + * * @param int $post_ID Post ID. * @param string $post_content Post Content for attachment. */ @@ -4716,12 +5028,19 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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]; $username = $args[1]; @@ -4737,9 +5056,10 @@ class wp_xmlrpc_server extends IXR_Server { $postdata = get_post( $post_ID, ARRAY_A ); - // If there is no post data for the give post id, stop - // now and return an error. Other wise a new post will be - // created (which was the old behavior). + /* + * If there is no post data for the give post id, stop now and return an error. + * Otherwise a new post will be created (which was the old behavior). + */ if ( ! $postdata || empty( $postdata[ 'ID' ] ) ) return new IXR_Error( 404, __( 'Invalid post ID.' ) ); @@ -4829,7 +5149,7 @@ class wp_xmlrpc_server extends IXR_Server { $comment_status = 'open'; break; default: - $comment_status = get_option('default_comment_status'); + $comment_status = get_default_comment_status( $post_type ); break; } } else { @@ -4842,7 +5162,7 @@ class wp_xmlrpc_server extends IXR_Server { $comment_status = 'open'; break; default: - $comment_status = get_option('default_comment_status'); + $comment_status = get_default_comment_status( $post_type ); break; } } @@ -4858,7 +5178,7 @@ class wp_xmlrpc_server extends IXR_Server { $ping_status = 'open'; break; default: - $ping_status = get_option('default_ping_status'); + $ping_status = get_default_comment_status( $post_type, 'pingback' ); break; } } else { @@ -4870,7 +5190,7 @@ class wp_xmlrpc_server extends IXR_Server { $ping_status = 'open'; break; default: - $ping_status = get_option('default_ping_status'); + $ping_status = get_default_comment_status( $post_type, 'pingback' ); break; } } @@ -4932,9 +5252,9 @@ class wp_xmlrpc_server extends IXR_Server { $to_ping = implode(' ', $to_ping); } - // Do some timestamp voodoo + // Do some timestamp voodoo. if ( !empty( $content_struct['date_created_gmt'] ) ) - // We know this is supposed to be GMT, so we're going to slap that Z on there by force + // We know this is supposed to be GMT, so we're going to slap that Z on there by force. $dateCreated = rtrim( $content_struct['date_created_gmt']->getIso(), 'Z' ) . 'Z'; elseif ( !empty( $content_struct['dateCreated']) ) $dateCreated = $content_struct['dateCreated']->getIso(); @@ -4947,7 +5267,7 @@ class wp_xmlrpc_server extends IXR_Server { $post_date_gmt = $postdata['post_date_gmt']; } - // We've got all the data -- post it: + // We've got all the data -- post it. $newpost = compact('ID', 'post_content', 'post_title', 'post_category', 'post_status', 'post_excerpt', 'comment_status', 'ping_status', 'post_date', 'post_date_gmt', 'to_ping', 'post_name', 'post_password', 'post_parent', 'menu_order', 'post_author', 'tags_input', 'page_template'); $result = wp_update_post($newpost, true); @@ -4972,7 +5292,8 @@ class wp_xmlrpc_server extends IXR_Server { $this->set_custom_fields($post_ID, $content_struct['custom_fields']); if ( isset ( $content_struct['wp_post_thumbnail'] ) ) { - // empty value deletes, non-empty value adds/updates + + // Empty value deletes, non-empty value adds/updates. if ( empty( $content_struct['wp_post_thumbnail'] ) ) { delete_post_thumbnail( $post_ID ); } else { @@ -4982,14 +5303,13 @@ class wp_xmlrpc_server extends IXR_Server { unset( $content_struct['wp_post_thumbnail'] ); } - // Handle enclosures + // Handle enclosures. $thisEnclosure = isset($content_struct['enclosure']) ? $content_struct['enclosure'] : null; $this->add_enclosure_if_new($post_ID, $thisEnclosure); $this->attach_uploads( $ID, $post_content ); - // Handle post formats if assigned, validation is handled - // earlier in this function + // Handle post formats if assigned, validation is handled earlier in this function. if ( isset( $content_struct['wp_post_format'] ) ) set_post_format( $post_ID, $content_struct['wp_post_format'] ); @@ -5011,16 +5331,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function mw_getPost( $args ) { + $this->escape( $args ); - $post_ID = (int) $args[0]; - $username = $args[1]; - $password = $args[2]; + $post_ID = (int) $args[0]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -5136,15 +5462,21 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function mw_getRecentPosts( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( isset( $args[3] ) ) $query = array( 'numberposts' => absint( $args[3] ) ); else @@ -5248,15 +5580,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ - public function mw_getCategories($args) { - - $this->escape($args); + public function mw_getCategories( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -5296,15 +5633,24 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @global wpdb $wpdb + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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'] ); $type = $data['type']; @@ -5409,15 +5755,21 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function mt_getRecentPostTitles( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( isset( $args[3] ) ) $query = array( 'numberposts' => absint( $args[3] ) ); else @@ -5463,15 +5815,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $blog_id (unused) + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ - public function mt_getCategoryList($args) { - - $this->escape($args); + public function mt_getCategoryList( $args ) { + $this->escape( $args ); - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -5502,16 +5859,21 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $post_ID + * @type string $username + * @type string $password + * } * @return array|IXR_Error */ - public function mt_getPostCategories($args) { - - $this->escape($args); + public function mt_getPostCategories( $args ) { + $this->escape( $args ); - $post_ID = (int) $args[0]; - $username = $args[1]; - $password = $args[2]; + $post_ID = (int) $args[0]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -5546,17 +5908,23 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. - * @return bool|IXR_Error True on success. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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); + public function mt_setPostCategories( $args ) { + $this->escape( $args ); - $post_ID = (int) $args[0]; - $username = $args[1]; + $post_ID = (int) $args[0]; + $username = $args[1]; $password = $args[2]; - $categories = $args[3]; + $categories = $args[3]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -5585,30 +5953,21 @@ class wp_xmlrpc_server extends IXR_Server { * * @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 ); } /** * Retrieve an empty array because we don't support per-post text filters. * * @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' ); @@ -5627,15 +5986,14 @@ class wp_xmlrpc_server extends IXR_Server { * * @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 */ do_action( 'xmlrpc_call', 'mt.getTrackbackPings' ); @@ -5670,16 +6028,21 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type int $post_ID + * @type string $username + * @type string $password + * } * @return int|IXR_Error */ - public function mt_publishPost($args) { - - $this->escape($args); + public function mt_publishPost( $args ) { + $this->escape( $args ); - $post_ID = (int) $args[0]; - $username = $args[1]; - $password = $args[2]; + $post_ID = (int) $args[0]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -5701,9 +6064,7 @@ class wp_xmlrpc_server extends IXR_Server { $postdata['post_category'] = $cats; $this->escape($postdata); - $result = wp_update_post($postdata); - - return $result; + return wp_update_post( $postdata ); } /* PingBack functions @@ -5715,23 +6076,28 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @global wpdb $wpdb + * @global string $wp_version + * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @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]; + $this->escape( $args ); - $pagelinkedfrom = str_replace('&', '&', $pagelinkedfrom); - $pagelinkedto = str_replace('&', '&', $pagelinkedto); - $pagelinkedto = str_replace('&', '&', $pagelinkedto); + $pagelinkedfrom = str_replace( '&', '&', $args[0] ); + $pagelinkedto = str_replace( '&', '&', $args[1] ); + $pagelinkedto = str_replace( '&', '&', $pagelinkedto ); /** * Filter the pingback source URI. @@ -5810,7 +6176,7 @@ class wp_xmlrpc_server extends IXR_Server { $remote_ip = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] ); /** 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 $http_api_args = array( @@ -5921,19 +6287,18 @@ class wp_xmlrpc_server extends IXR_Server { * * @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; /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'pingback.extensions.getPingbacks' ); - $this->escape($args); - - $url = $args; + $url = $this->escape( $url ); $post_ID = url_to_postid($url); if ( !$post_ID ) { @@ -5965,6 +6330,7 @@ class wp_xmlrpc_server extends IXR_Server { /** * @param integer $code * @param string $message + * @return IXR_Error */ protected function pingback_error( $code, $message ) { /**