X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f5fcdc7994bb67cce809bc4777944ae8b7fad4a4..8d3bb1a5dcfdea9857d3c88c3751f09593e34dc8:/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..be2d3edb 100644 --- a/wp-includes/class-wp-xmlrpc-server.php +++ b/wp-includes/class-wp-xmlrpc-server.php @@ -14,7 +14,7 @@ * options, etc. * * As of WordPress 3.5.0, XML-RPC is enabled by default. It can be disabled - * via the xmlrpc_enabled filter found in wp_xmlrpc_server::login(). + * via the {@see 'xmlrpc_enabled'} filter found in wp_xmlrpc_server::login(). * * @package WordPress * @subpackage Publishing @@ -22,23 +22,43 @@ */ 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; + + /** + * Flags that the user authentication has failed in this instance of wp_xmlrpc_server. + * + * @access protected + * @var bool + */ + protected $auth_failed = false; + /** - * Register all of the XMLRPC methods that XMLRPC server understands. + * Registers all of the XMLRPC methods that XMLRPC server understands. * * Sets up server and method property. Passes XMLRPC - * methods through the 'xmlrpc_methods' filter to allow plugins to extend - * or replace XMLRPC methods. + * methods through the {@see 'xmlrpc_methods'} filter to allow plugins to extend + * or replace XML-RPC methods. * * @since 1.5.0 */ @@ -139,7 +159,7 @@ class wp_xmlrpc_server extends IXR_Server { $this->initialise_blog_option_info(); /** - * Filter the methods exposed by the XML-RPC server. + * Filters the methods exposed by the XML-RPC server. * * This filter can be used to add new methods, and remove built-in methods. * @@ -151,14 +171,14 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * Make private/protected methods readable for backwards compatibility. + * Make private/protected methods readable for backward compatibility. * * @since 4.0.0 * @access public * * @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 +187,12 @@ class wp_xmlrpc_server extends IXR_Server { return false; } + /** + * Serves the XML-RPC request. + * + * @since 2.9.0 + * @access public + */ public function serve_request() { $this->IXR_Server($this->methods); } @@ -176,10 +202,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 +213,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; @@ -217,9 +247,22 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * Filter whether XML-RPC is enabled. + * Filters whether XML-RPC methods requiring authentication are enabled. + * + * Contrary to the way it's named, this filter does not control whether XML-RPC is *fully* + * enabled, rather, it only controls whether XML-RPC methods requiring authentication - such + * as for publishing purposes - are enabled. * - * This is the proper filter for turning off XML-RPC. + * Further, the filter does not control whether pingbacks or other custom endpoints that don't + * require authentication are enabled. This behavior is expected, and due to how parity was matched + * with the `enable_xmlrpc` UI option the filter replaced when it was introduced in 3.5. + * + * To disable XML-RPC methods that require authentication, use: + * + * add_filter( 'xmlrpc_enabled', '__return_false' ); + * + * For more granular control over all XML-RPC methods and requests, see the {@see 'xmlrpc_methods'} + * and {@see 'xmlrpc_element_limit'} hooks. * * @since 3.5.0 * @@ -232,13 +275,20 @@ class wp_xmlrpc_server extends IXR_Server { return false; } - $user = wp_authenticate($username, $password); + if ( $this->auth_failed ) { + $user = new WP_Error( 'login_prevented' ); + } else { + $user = wp_authenticate( $username, $password ); + } - if (is_wp_error($user)) { + if ( is_wp_error( $user ) ) { $this->error = new IXR_Error( 403, __( 'Incorrect username or password.' ) ); + // Flag that authentication has failed once on this wp_xmlrpc_server instance + $this->auth_failed = true; + /** - * Filter the XML-RPC user login error message. + * Filters the XML-RPC user login error message. * * @since 3.5.0 * @@ -257,9 +307,8 @@ class wp_xmlrpc_server extends IXR_Server { * Check user's credentials. Deprecated. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated use wp_xmlrpc_server::login - * @see wp_xmlrpc_server::login + * @deprecated 2.8.0 Use wp_xmlrpc_server::login() + * @see wp_xmlrpc_server::login() * * @param string $username User's username. * @param string $password User's password. @@ -275,7 +324,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 +401,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; @@ -477,6 +529,16 @@ class wp_xmlrpc_server extends IXR_Server { 'readonly' => false, 'option' => 'medium_size_h' ), + 'medium_large_size_w' => array( + 'desc' => __( 'Medium-Large size image width' ), + 'readonly' => false, + 'option' => 'medium_large_size_w' + ), + 'medium_large_size_h' => array( + 'desc' => __( 'Medium-Large size image height' ), + 'readonly' => false, + 'option' => 'medium_large_size_h' + ), 'large_size_w' => array( 'desc' => __( 'Large size image width' ), 'readonly' => false, @@ -493,14 +555,14 @@ 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' ) ); /** - * Filter the XML-RPC blog options property. + * Filters the XML-RPC blog options property. * * @since 2.6.0 * @@ -514,11 +576,15 @@ 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' + * - 'isPrimary' - whether the blog is the user's primary blog * - 'url' * - 'blogid' * - 'blogName' @@ -548,15 +614,20 @@ 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' ); $blogs = (array) get_blogs_of_user( $user->ID ); $struct = array(); + $primary_blog_id = 0; + $active_blog = get_active_blog_for_user( $user->ID ); + if ( $active_blog ) { + $primary_blog_id = (int) $active_blog->blog_id; + } 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; @@ -565,13 +636,15 @@ class wp_xmlrpc_server extends IXR_Server { switch_to_blog( $blog_id ); $is_admin = current_user_can( 'manage_options' ); + $is_primary = ( (int) $blog_id === $primary_blog_id ); $struct[] = array( - 'isAdmin' => $is_admin, - 'url' => home_url( '/' ), - 'blogid' => (string) $blog_id, - 'blogName' => get_option( 'blogname' ), - 'xmlrpc' => site_url( 'xmlrpc.php', 'rpc' ), + 'isAdmin' => $is_admin, + 'isPrimary' => $is_primary, + 'url' => home_url( '/' ), + 'blogid' => (string) $blog_id, + 'blogName' => get_option( 'blogname' ), + 'xmlrpc' => site_url( 'xmlrpc.php', 'rpc' ), ); restore_current_blog(); @@ -584,10 +657,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 +677,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( @@ -630,7 +704,7 @@ class wp_xmlrpc_server extends IXR_Server { $_taxonomy['object_type'] = array_unique( (array) $taxonomy->object_type ); /** - * Filter XML-RPC-prepared data for the given taxonomy. + * Filters XML-RPC-prepared data for the given taxonomy. * * @since 3.4.0 * @@ -646,12 +720,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. @@ -664,7 +738,7 @@ class wp_xmlrpc_server extends IXR_Server { $_term['count'] = intval( $_term['count'] ); /** - * Filter XML-RPC-prepared data for the given term. + * Filters XML-RPC-prepared data for the given term. * * @since 3.4.0 * @@ -679,8 +753,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 +768,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 +784,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'] ), @@ -734,7 +808,7 @@ class wp_xmlrpc_server extends IXR_Server { 'post_content' => $post['post_content'], 'post_parent' => strval( $post['post_parent'] ), 'post_mime_type' => $post['post_mime_type'], - 'link' => post_permalink( $post['ID'] ), + 'link' => get_permalink( $post['ID'] ), 'guid' => $post['guid'], 'menu_order' => intval( $post['menu_order'] ), 'comment_status' => $post['comment_status'], @@ -742,7 +816,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 +824,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 { @@ -793,7 +867,7 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * Filter XML-RPC-prepared date for the given post. + * Filters XML-RPC-prepared date for the given post. * * @since 3.4.0 * @@ -807,11 +881,13 @@ class wp_xmlrpc_server extends IXR_Server { /** * Prepares post data for return in an XML-RPC object. * + * @since 3.4.0 + * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object. * @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 WP_Post_Type $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( @@ -844,12 +920,13 @@ class wp_xmlrpc_server extends IXR_Server { $_post_type['taxonomies'] = get_object_taxonomies( $post_type->name, 'names' ); /** - * Filter XML-RPC-prepared date for the given post type. + * Filters XML-RPC-prepared date for the given post type. * * @since 3.4.0 + * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object. * - * @param array $_post_type An array of post type data. - * @param object $post_type Post type object. + * @param array $_post_type An array of post type data. + * @param WP_Post_Type $post_type Post type object. */ return apply_filters( 'xmlrpc_prepare_post_type', $_post_type, $post_type ); } @@ -859,9 +936,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( @@ -873,6 +950,7 @@ class wp_xmlrpc_server extends IXR_Server { 'caption' => $media_item->post_excerpt, 'description' => $media_item->post_content, 'metadata' => wp_get_attachment_metadata( $media_item->ID ), + 'type' => $media_item->post_mime_type ); $thumbnail_src = image_downsize( $media_item->ID, $thumbnail_size ); @@ -882,7 +960,7 @@ class wp_xmlrpc_server extends IXR_Server { $_media_item['thumbnail'] = $_media_item['link']; /** - * Filter XML-RPC-prepared data for the given media item. + * Filters XML-RPC-prepared data for the given media item. * * @since 3.4.0 * @@ -898,13 +976,13 @@ 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. $full_page = get_extended( $page->post_content ); - $link = post_permalink( $page->ID ); + $link = get_permalink( $page->ID ); // Get info the page parent if there is one. $parent_title = ""; @@ -964,7 +1042,7 @@ class wp_xmlrpc_server extends IXR_Server { ); /** - * Filter XML-RPC-prepared data for the given page. + * Filters XML-RPC-prepared data for the given page. * * @since 3.4.0 * @@ -979,8 +1057,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. @@ -1013,12 +1091,12 @@ class wp_xmlrpc_server extends IXR_Server { ); /** - * Filter XML-RPC-prepared data for the given comment. + * Filters 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. + * @param array $_comment An array of prepared comment data. + * @param WP_Comment $comment Comment object. */ return apply_filters( 'xmlrpc_prepare_comment', $_comment, $comment ); } @@ -1028,9 +1106,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 ) ); @@ -1061,7 +1139,7 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * Filter XML-RPC-prepared data for the given user. + * Filters XML-RPC-prepared data for the given user. * * @since 3.5.0 * @@ -1077,31 +1155,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 https://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 +1244,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 +1273,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 +1283,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 * - * @param WP_User $user The post author if post_author isn't set in $content_struct. + * @see wp_insert_post() + * + * @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, @@ -1217,7 +1302,7 @@ class wp_xmlrpc_server extends IXR_Server { $post_type = get_post_type_object( $post_data['post_type'] ); if ( ! $post_type ) - return new IXR_Error( 403, __( 'Invalid post type' ) ); + return new IXR_Error( 403, __( 'Invalid post type.' ) ); $update = ! empty( $post_data['ID'] ); @@ -1258,7 +1343,7 @@ class wp_xmlrpc_server extends IXR_Server { $post_data['post_author'] = absint( $post_data['post_author'] ); if ( ! empty( $post_data['post_author'] ) && $post_data['post_author'] != $user->ID ) { if ( ! current_user_can( $post_type->cap->edit_others_posts ) ) - return new IXR_Error( 401, __( 'You are not allowed to create posts as this user.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to create posts as this user.' ) ); $author = get_userdata( $post_data['post_author'] ); @@ -1274,17 +1359,23 @@ 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(); } + // Default to not flagging the post date to be edited unless it's intentional. + $post_data['edit_date'] = false; + if ( ! empty( $dateCreated ) ) { $post_data['post_date'] = get_date_from_gmt( iso8601_to_datetime( $dateCreated ) ); $post_data['post_date_gmt'] = iso8601_to_datetime( $dateCreated, 'GMT' ); + + // Flag the post date to be edited. + $post_data['edit_date'] = true; } if ( ! isset( $post_data['ID'] ) ) @@ -1299,7 +1390,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 +1405,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.' ) ); @@ -1335,14 +1426,14 @@ class wp_xmlrpc_server extends IXR_Server { $term = get_term_by( 'id', $term_id, $taxonomy ); if ( ! $term ) - return new IXR_Error( 403, __( 'Invalid term ID' ) ); + return new IXR_Error( 403, __( 'Invalid term ID.' ) ); $terms[$taxonomy][] = (int) $term_id; } } } - // 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 +1444,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 +1469,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 +1489,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,14 +1502,14 @@ 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 ); $this->attach_uploads( $post_ID, $post_data['post_content'] ); /** - * Filter post data array to be inserted via XML-RPC. + * Filters post data array to be inserted via XML-RPC. * * @since 3.4.0 * @@ -1442,13 +1536,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 +1576,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 +1603,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 ) ) @@ -1529,16 +1632,19 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.deletePost' ); $post = get_post( $post_id, ARRAY_A ); - if ( empty( $post['ID'] ) ) + if ( empty( $post['ID'] ) ) { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + } - if ( ! current_user_can( 'delete_post', $post_id ) ) + if ( ! current_user_can( 'delete_post', $post_id ) ) { return new IXR_Error( 401, __( 'Sorry, you are not allowed to delete this post.' ) ); + } $result = wp_delete_post( $post_id ); - if ( ! $result ) + if ( ! $result ) { return new IXR_Error( 500, __( 'The post cannot be deleted.' ) ); + } return true; } @@ -1557,13 +1663,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,19 +1704,19 @@ 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]; } else { /** - * Filter the list of post query fields used by the given XML-RPC method. + * Filters 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 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' ); @@ -1624,7 +1734,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( ! current_user_can( 'edit_post', $post_id ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); return $this->_prepare_post( $post, $fields ); } @@ -1634,23 +1744,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', 's', 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 +1767,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]; @@ -1687,7 +1795,7 @@ class wp_xmlrpc_server extends IXR_Server { } if ( ! current_user_can( $post_type->cap->edit_posts ) ) - return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts in this post type' )); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts in this post type.' )); $query['post_type'] = $post_type->name; @@ -1716,7 +1824,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 +1842,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 +1862,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; @@ -1766,12 +1873,12 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.newTerm' ); if ( ! taxonomy_exists( $content_struct['taxonomy'] ) ) - return new IXR_Error( 403, __( 'Invalid taxonomy' ) ); + return new IXR_Error( 403, __( 'Invalid taxonomy.' ) ); $taxonomy = get_taxonomy( $content_struct['taxonomy'] ); if ( ! current_user_can( $taxonomy->cap->manage_terms ) ) - return new IXR_Error( 401, __( 'You are not allowed to create terms in this taxonomy.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to create terms in this taxonomy.' ) ); $taxonomy = (array) $taxonomy; @@ -1820,21 +1927,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 +1948,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; @@ -1854,12 +1960,12 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.editTerm' ); if ( ! taxonomy_exists( $content_struct['taxonomy'] ) ) - return new IXR_Error( 403, __( 'Invalid taxonomy' ) ); + return new IXR_Error( 403, __( 'Invalid taxonomy.' ) ); $taxonomy = get_taxonomy( $content_struct['taxonomy'] ); if ( ! current_user_can( $taxonomy->cap->edit_terms ) ) - return new IXR_Error( 401, __( 'You are not allowed to edit terms in this taxonomy.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit terms in this taxonomy.' ) ); $taxonomy = (array) $taxonomy; @@ -1872,7 +1978,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 500, $term->get_error_message() ); if ( ! $term ) - return new IXR_Error( 404, __( 'Invalid term ID' ) ); + return new IXR_Error( 404, __( 'Invalid term ID.' ) ); if ( isset( $content_struct['name'] ) ) { $term_data['name'] = trim( $content_struct['name'] ); @@ -1881,7 +1987,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 403, __( 'The term name cannot be empty.' ) ); } - if ( isset( $content_struct['parent'] ) ) { + if ( ! empty( $content_struct['parent'] ) ) { if ( ! $taxonomy['hierarchical'] ) return new IXR_Error( 403, __( "This taxonomy is not hierarchical so you can't set a parent." ) ); @@ -1919,14 +2025,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 ) ) @@ -1946,12 +2056,12 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.deleteTerm' ); if ( ! taxonomy_exists( $taxonomy ) ) - return new IXR_Error( 403, __( 'Invalid taxonomy' ) ); + return new IXR_Error( 403, __( 'Invalid taxonomy.' ) ); $taxonomy = get_taxonomy( $taxonomy ); if ( ! current_user_can( $taxonomy->cap->delete_terms ) ) - return new IXR_Error( 401, __( 'You are not allowed to delete terms in this taxonomy.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to delete terms in this taxonomy.' ) ); $term = get_term( $term_id, $taxonomy->name ); @@ -1959,7 +2069,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 500, $term->get_error_message() ); if ( ! $term ) - return new IXR_Error( 404, __( 'Invalid term ID' ) ); + return new IXR_Error( 404, __( 'Invalid term ID.' ) ); $result = wp_delete_term( $term_id, $taxonomy->name ); @@ -1977,14 +2087,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' @@ -2013,12 +2127,12 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.getTerm' ); if ( ! taxonomy_exists( $taxonomy ) ) - return new IXR_Error( 403, __( 'Invalid taxonomy' ) ); + return new IXR_Error( 403, __( 'Invalid taxonomy.' ) ); $taxonomy = get_taxonomy( $taxonomy ); if ( ! current_user_can( $taxonomy->cap->assign_terms ) ) - return new IXR_Error( 401, __( 'You are not allowed to assign terms in this taxonomy.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to assign terms in this taxonomy.' ) ); $term = get_term( $term_id , $taxonomy->name, ARRAY_A ); @@ -2026,7 +2140,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 500, $term->get_error_message() ); if ( ! $term ) - return new IXR_Error( 404, __( 'Invalid term ID' ) ); + return new IXR_Error( 404, __( 'Invalid term ID.' ) ); return $this->_prepare_term( $term ); } @@ -2039,14 +2153,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 ) ) @@ -2066,12 +2185,12 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.getTerms' ); if ( ! taxonomy_exists( $taxonomy ) ) - return new IXR_Error( 403, __( 'Invalid taxonomy' ) ); + return new IXR_Error( 403, __( 'Invalid taxonomy.' ) ); $taxonomy = get_taxonomy( $taxonomy ); if ( ! current_user_can( $taxonomy->cap->assign_terms ) ) - return new IXR_Error( 401, __( 'You are not allowed to assign terms in this taxonomy.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to assign terms in this taxonomy.' ) ); $query = array(); @@ -2115,13 +2234,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,15 +2255,15 @@ 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]; } else { /** - * Filter the taxonomy query fields used by the given XML-RPC method. + * Filters the taxonomy query fields used by the given XML-RPC method. * * @since 3.4.0 * @@ -2154,12 +2280,12 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.getTaxonomy' ); if ( ! taxonomy_exists( $taxonomy ) ) - return new IXR_Error( 403, __( 'Invalid taxonomy' ) ); + return new IXR_Error( 403, __( 'Invalid taxonomy.' ) ); $taxonomy = get_taxonomy( $taxonomy ); if ( ! current_user_can( $taxonomy->cap->assign_terms ) ) - return new IXR_Error( 401, __( 'You are not allowed to assign terms in this taxonomy.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to assign terms in this taxonomy.' ) ); return $this->_prepare_taxonomy( $taxonomy, $fields ); } @@ -2169,12 +2295,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 +2315,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 +2360,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,15 +2390,15 @@ 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]; } else { /** - * Filter the default user query fields used by the given XML-RPC method. + * Filters the default user query fields used by the given XML-RPC method. * * @since 3.5.0 * @@ -2278,12 +2415,12 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.getUser' ); if ( ! current_user_can( 'edit_user', $user_id ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit users.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this user.' ) ); $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 +2438,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 +2455,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]; @@ -2333,7 +2473,7 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.getUsers' ); if ( ! current_user_can( 'list_users' ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot list users.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to browse users.' ) ); $query = array( 'fields' => 'all_with_meta' ); @@ -2372,11 +2512,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 +2529,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]; @@ -2402,7 +2546,7 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.getProfile' ); if ( ! current_user_can( 'edit_user', $user->ID ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit your profile.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit your profile.' ) ); $user_data = get_userdata( $user->ID ); @@ -2413,12 +2557,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 +2572,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 ) ) @@ -2445,7 +2592,7 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.editProfile' ); if ( ! current_user_can( 'edit_user', $user->ID ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit your profile.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit your profile.' ) ); // holds data of the user $user_data = array(); @@ -2489,19 +2636,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; @@ -2512,7 +2662,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( !current_user_can( 'edit_page', $page_id ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit this page.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this page.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getPage' ); @@ -2532,25 +2682,28 @@ 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; if ( !current_user_can( 'edit_pages' ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit pages.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit pages.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getPages' ); @@ -2578,13 +2731,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 +2766,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; @@ -2628,7 +2797,7 @@ class wp_xmlrpc_server extends IXR_Server { // Make sure the user can delete pages. if ( !current_user_can('delete_page', $page_id) ) - return new IXR_Error( 401, __( 'Sorry, you do not have the right to delete this page.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to delete this page.' ) ); // Attempt to delete the page. $result = wp_delete_post($page_id); @@ -2653,19 +2822,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' ); @@ -2677,7 +2859,7 @@ class wp_xmlrpc_server extends IXR_Server { // Make sure the user is allowed to edit pages. if ( !current_user_can('edit_page', $page_id) ) - return new IXR_Error( 401, __( 'Sorry, you do not have the right to edit this page.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this page.' ) ); // Mark this as content for a page. $content['post_type'] = 'page'; @@ -2700,22 +2882,30 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @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; if ( !current_user_can( 'edit_pages' ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit pages.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit pages.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getPageList' ); @@ -2752,21 +2942,26 @@ 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; if ( !current_user_can('edit_posts') ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit posts on this site.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getAuthors' ); @@ -2788,14 +2983,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; @@ -2809,7 +3010,7 @@ class wp_xmlrpc_server extends IXR_Server { $tags = array(); if ( $all_tags = get_tags() ) { - foreach( (array) $all_tags as $tag ) { + foreach ( (array) $all_tags as $tag ) { $struct = array(); $struct['tag_id'] = $tag->term_id; $struct['name'] = $tag->name; @@ -2830,15 +3031,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; @@ -2848,7 +3056,7 @@ class wp_xmlrpc_server extends IXR_Server { // Make sure the user is allowed to add a category. if ( !current_user_can('manage_categories') ) - return new IXR_Error(401, __('Sorry, you do not have the right to add a category.')); + return new IXR_Error(401, __('Sorry, you are not allowed to add a category.')); // If no slug was provided make it empty so that // WordPress will generate one. @@ -2899,15 +3107,22 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param array $args Method parameters. - * @return bool|IXR_Error See {@link wp_delete_term()} for return info. + * @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 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; @@ -2916,7 +3131,7 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'wp.deleteCategory' ); if ( !current_user_can('manage_categories') ) - return new IXR_Error( 401, __( 'Sorry, you do not have the right to delete a category.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to delete a category.' ) ); $status = wp_delete_term( $category_id, 'category' ); @@ -2940,16 +3155,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 +3200,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) { @@ -2987,17 +3217,20 @@ class wp_xmlrpc_server extends IXR_Server { $password = $args[2]; $comment_id = (int) $args[3]; - if ( !$user = $this->login($username, $password) ) + if ( ! $user = $this->login( $username, $password ) ) { return $this->error; - - if ( !current_user_can( 'moderate_comments' ) ) - return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) ); + } /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getComment' ); - if ( ! $comment = get_comment($comment_id) ) + if ( ! $comment = get_comment( $comment_id ) ) { return new IXR_Error( 404, __( 'Invalid comment ID.' ) ); + } + + if ( ! current_user_can( 'edit_comment', $comment_id ) ) { + return new IXR_Error( 403, __( 'Sorry, you are not allowed to moderate or edit this comment.' ) ); + } return $this->_prepare_comment( $comment ); } @@ -3014,52 +3247,81 @@ class wp_xmlrpc_server extends IXR_Server { * - 'status' - Default is ''. Filter by status (e.g., 'approve', 'hold') * - 'post_id' - Default is ''. The post where the comment is posted. Empty string shows all comments. * - 'number' - Default is 10. 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. * * @since 2.7.0 * - * @param array $args Method parameters. - * @return array|IXR_Error Contains a collection of comments. See {@link wp_xmlrpc_server::wp_getComment()} 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 comments. See 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) ) + if ( ! $user = $this->login( $username, $password ) ) { return $this->error; - - if ( !current_user_can( 'moderate_comments' ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit comments.' ) ); + } /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getComments' ); - if ( isset($struct['status']) ) + if ( isset( $struct['status'] ) ) { $status = $struct['status']; - else + } else { $status = ''; + } + + if ( ! current_user_can( 'moderate_comments' ) && 'approve' !== $status ) { + return new IXR_Error( 401, __( 'Invalid comment status.' ) ); + } $post_id = ''; - if ( isset($struct['post_id']) ) - $post_id = absint($struct['post_id']); + if ( isset( $struct['post_id'] ) ) { + $post_id = absint( $struct['post_id'] ); + } + + $post_type = ''; + if ( isset( $struct['post_type'] ) ) { + $post_type_object = get_post_type_object( $struct['post_type'] ); + if ( ! $post_type_object || ! post_type_supports( $post_type_object->name, 'comments' ) ) { + return new IXR_Error( 404, __( 'Invalid post type.' ) ); + } + $post_type = $struct['post_type']; + } $offset = 0; - if ( isset($struct['offset']) ) - $offset = absint($struct['offset']); + if ( isset( $struct['offset'] ) ) { + $offset = absint( $struct['offset'] ); + } $number = 10; - if ( isset($struct['number']) ) - $number = absint($struct['number']); + 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, + 'post_type' => $post_type, + ) ); $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; @@ -3069,43 +3331,45 @@ class wp_xmlrpc_server extends IXR_Server { * Delete a comment. * * By default, the comment will be moved to the trash instead of deleted. - * See {@link wp_delete_comment()} for more information on - * this behavior. + * See wp_delete_comment() for more information on this behavior. * * @since 2.7.0 * - * @param array $args Method parameters. Contains: - * - blog_id (unused) - * - username - * - password - * - comment_id - * @return bool|IXR_Error {@link wp_delete_comment()} + * @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 See wp_delete_comment(). */ - public function wp_deleteComment($args) { + public function wp_deleteComment( $args ) { $this->escape($args); $username = $args[1]; $password = $args[2]; $comment_ID = (int) $args[3]; - if ( !$user = $this->login($username, $password) ) + if ( ! $user = $this->login( $username, $password ) ) { return $this->error; + } - if ( !current_user_can( 'moderate_comments' ) ) - return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) ); - - if ( ! get_comment($comment_ID) ) + if ( ! get_comment( $comment_ID ) ) { return new IXR_Error( 404, __( 'Invalid comment ID.' ) ); + } - if ( !current_user_can( 'edit_comment', $comment_ID ) ) - return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) ); + if ( !current_user_can( 'edit_comment', $comment_ID ) ) { + return new IXR_Error( 403, __( 'Sorry, you are not allowed to moderate or edit this comment.' ) ); + } /** 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 ( $status ) { /** * Fires after a comment has been successfully deleted via XML-RPC. * @@ -3132,37 +3396,40 @@ 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]; $comment_ID = (int) $args[3]; $content_struct = $args[4]; - if ( !$user = $this->login($username, $password) ) + if ( !$user = $this->login( $username, $password ) ) { return $this->error; + } - if ( !current_user_can( 'moderate_comments' ) ) - return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) ); - - if ( ! get_comment($comment_ID) ) + if ( ! get_comment( $comment_ID ) ) { return new IXR_Error( 404, __( 'Invalid comment ID.' ) ); + } - if ( !current_user_can( 'edit_comment', $comment_ID ) ) - return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) ); + if ( ! current_user_can( 'edit_comment', $comment_ID ) ) { + return new IXR_Error( 403, __( 'Sorry, you are not allowed to moderate or edit this comment.' ) ); + } /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.editComment' ); @@ -3224,19 +3491,27 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. - * @return int|IXR_Error {@link wp_new_comment()} + * @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 See 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]; /** - * Filter whether to allow anonymous comments over XML-RPC. + * Filters whether to allow anonymous comments over XML-RPC. * * @since 2.7.0 * @@ -3263,19 +3538,29 @@ class wp_xmlrpc_server extends IXR_Server { else $post_id = url_to_postid($post); - if ( ! $post_id ) + if ( ! $post_id ) { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + } - if ( ! get_post($post_id) ) + if ( ! get_post( $post_id ) ) { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + } + + if ( ! comments_open( $post_id ) ) { + return new IXR_Error( 403, __( 'Sorry, comments are closed for this item.' ) ); + } $comment = array(); $comment['comment_post_ID'] = $post_id; if ( $logged_in ) { - $comment['comment_author'] = $this->escape( $user->display_name ); - $comment['comment_author_email'] = $this->escape( $user->user_email ); - $comment['comment_author_url'] = $this->escape( $user->user_url ); + $display_name = $user->display_name; + $user_email = $user->user_email; + $user_url = $user->user_url; + + $comment['comment_author'] = $this->escape( $display_name ); + $comment['comment_author_email'] = $this->escape( $user_email ); + $comment['comment_author_url'] = $this->escape( $user_url ); $comment['user_ID'] = $user->ID; } else { $comment['comment_author'] = ''; @@ -3327,20 +3612,28 @@ 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) { + 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) ) + if ( ! $user = $this->login( $username, $password ) ) { return $this->error; + } - if ( !current_user_can( 'moderate_comments' ) ) - return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) ); + if ( ! current_user_can( 'publish_posts' ) ) { + return new IXR_Error( 403, __( 'Sorry, 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.getCommentStatusList' ); @@ -3353,26 +3646,41 @@ 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]; $post_id = (int) $args[3]; - if ( !$user = $this->login($username, $password) ) + if ( ! $user = $this->login( $username, $password ) ) { return $this->error; + } - if ( !current_user_can( 'edit_posts' ) ) - return new IXR_Error( 403, __( 'You are not allowed access to details about comments.' ) ); + $post = get_post( $post_id, ARRAY_A ); + if ( empty( $post['ID'] ) ) { + return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + } + + if ( ! current_user_can( 'edit_post', $post_id ) ) { + return new IXR_Error( 403, __( 'Sorry, you are not allowed access to details of this post.' ) ); + } /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getCommentCount' ); $count = wp_count_comments( $post_id ); + return array( 'approved' => $count->approved, 'awaiting_moderation' => $count->moderated, @@ -3386,20 +3694,26 @@ 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; if ( !current_user_can( 'edit_posts' ) ) - return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) ); + return new IXR_Error( 403, __( 'Sorry, 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.getPostStatusList' ); @@ -3412,20 +3726,26 @@ 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; if ( !current_user_can( 'edit_pages' ) ) - return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) ); + return new IXR_Error( 403, __( 'Sorry, 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.getPageStatusList' ); @@ -3438,20 +3758,26 @@ 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; if ( !current_user_can( 'edit_pages' ) ) - return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) ); + return new IXR_Error( 403, __( 'Sorry, you are not allowed access to details about this site.' ) ); $templates = get_page_templates(); $templates['Default'] = 'default'; @@ -3464,7 +3790,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 +3850,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 ) { @@ -3531,7 +3871,7 @@ class wp_xmlrpc_server extends IXR_Server { return $this->error; if ( !current_user_can( 'manage_options' ) ) - return new IXR_Error( 403, __( 'You are not allowed to update options.' ) ); + return new IXR_Error( 403, __( 'Sorry, you are not allowed to update options.' ) ); $option_names = array(); foreach ( $options as $o_name => $o_value ) { @@ -3554,11 +3894,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 +3912,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]; @@ -3580,7 +3923,7 @@ class wp_xmlrpc_server extends IXR_Server { return $this->error; if ( !current_user_can( 'upload_files' ) ) - return new IXR_Error( 403, __( 'You do not have permission to upload files.' ) ); + return new IXR_Error( 403, __( 'Sorry, you are not allowed to upload files.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getMediaItem' ); @@ -3601,18 +3944,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); @@ -3625,7 +3971,7 @@ class wp_xmlrpc_server extends IXR_Server { return $this->error; if ( !current_user_can( 'upload_files' ) ) - return new IXR_Error( 401, __( 'You do not have permission to upload files.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to upload files.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getMediaLibrary' ); @@ -3646,16 +3992,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 ); @@ -3666,7 +4015,7 @@ class wp_xmlrpc_server extends IXR_Server { return $this->error; if ( !current_user_can( 'edit_posts' ) ) - return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) ); + return new IXR_Error( 403, __( 'Sorry, 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' ); @@ -3696,13 +4045,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' @@ -3728,7 +4081,7 @@ class wp_xmlrpc_server extends IXR_Server { $fields = $args[4]; } else { /** - * Filter the default query fields used by the given XML-RPC method. + * Filters the default query fields used by the given XML-RPC method. * * @since 3.4.0 * @@ -3744,12 +4097,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 ) ) - return new IXR_Error( 403, __( 'Invalid post type' ) ); + 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 +4113,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 +4132,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]; @@ -3796,8 +4153,8 @@ class wp_xmlrpc_server extends IXR_Server { $struct = array(); - foreach( $post_types as $post_type ) { - if( ! current_user_can( $post_type->cap->edit_posts ) ) + foreach ( $post_types as $post_type ) { + if ( ! current_user_can( $post_type->cap->edit_posts ) ) continue; $struct[$post_type->name] = $this->_prepare_post_type( $post_type, $fields ); @@ -3817,12 +4174,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,15 +4191,15 @@ 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]; } else { /** - * Filter the default revision query fields used by the given XML-RPC method. + * Filters the default revision query fields used by the given XML-RPC method. * * @since 3.5.0 * @@ -3856,7 +4216,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 +4253,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,16 +4280,16 @@ 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.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); // Check if revisions are disabled. if ( ! wp_revisions_enabled( $post ) ) @@ -3938,7 +4301,7 @@ class wp_xmlrpc_server extends IXR_Server { } /* Blogger API functions. - * specs on http://plant.blogger.com/api and http://groups.yahoo.com/group/bloggerDev/ + * specs on http://plant.blogger.com/api and https://groups.yahoo.com/group/bloggerDev/ */ /** @@ -3948,7 +4311,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 +4327,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; @@ -3982,11 +4351,18 @@ class wp_xmlrpc_server extends IXR_Server { /** * Private function for retrieving a users blogs for multisite setups * + * @since 3.0.0 * @access protected * + * @param array $args { + * Method arguments. Note: arguments must be ordered as documented. + * + * @type string $username Username. + * @type string $password Password. + * } * @return array|IXR_Error */ - protected function _multisite_getUsersBlogs($args) { + protected function _multisite_getUsersBlogs( $args ) { $current_blog = get_blog_details(); $domain = $current_blog->domain; @@ -4017,21 +4393,26 @@ 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; if ( !current_user_can( 'edit_posts' ) ) - return new IXR_Error( 401, __( 'Sorry, you do not have access to user data on this site.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to access user data on this site.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'blogger.getUserInfo' ); @@ -4052,16 +4433,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; @@ -4071,7 +4458,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( !current_user_can( 'edit_post', $post_ID ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'blogger.getPost' ); @@ -4097,16 +4484,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 @@ -4116,7 +4511,7 @@ class wp_xmlrpc_server extends IXR_Server { return $this->error; if ( ! current_user_can( 'edit_posts' ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit posts on this site.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'blogger.getRecentPosts' ); @@ -4156,7 +4551,9 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * @deprecated 3.5.0 - * @return IXR_Error + * + * @param array $args Unused. + * @return IXR_Error Error object. */ public function blogger_getTemplate($args) { return new IXR_Error( 403, __('Sorry, that file cannot be edited.' ) ); @@ -4167,28 +4564,38 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * @deprecated 3.5.0 - * @return IXR_Error + * + * @param array $args Unused. + * @return IXR_Error Error object. */ public function blogger_setTemplate($args) { return new IXR_Error( 403, __('Sorry, that file cannot be edited.' ) ); } /** - * Create new post. + * Creates new post. * * @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 +4647,27 @@ 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 + * @type bool $publish + * } + * @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]; + $publish = $args[5]; if ( ! $user = $this->login( $username, $password ) ) { return $this->error; @@ -4268,10 +4685,10 @@ class wp_xmlrpc_server extends IXR_Server { $this->escape($actual_post); if ( ! current_user_can( 'edit_post', $post_ID ) ) { - return new IXR_Error(401, __('Sorry, you do not have the right to edit this post.')); + return new IXR_Error(401, __('Sorry, you are not allowed to edit this post.')); } if ( 'publish' == $actual_post['post_status'] && ! current_user_can( 'publish_posts' ) ) { - return new IXR_Error( 401, __( 'Sorry, you do not have the right to publish this post.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to publish this post.' ) ); } $postdata = array(); @@ -4281,6 +4698,7 @@ class wp_xmlrpc_server extends IXR_Server { $postdata['post_category'] = xmlrpc_getpostcategory( $content ); $postdata['post_status'] = $actual_post['post_status']; $postdata['post_excerpt'] = $actual_post['post_excerpt']; + $postdata['post_status'] = $publish ? 'publish' : 'draft'; $result = wp_update_post( $postdata ); @@ -4307,15 +4725,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; @@ -4323,18 +4748,21 @@ class wp_xmlrpc_server extends IXR_Server { /** 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); + $actual_post = get_post( $post_ID, ARRAY_A ); - if ( !$actual_post || $actual_post['post_type'] != 'post' ) - return new IXR_Error(404, __('Sorry, no such post.')); + if ( ! $actual_post || $actual_post['post_type'] != 'post' ) { + return new IXR_Error( 404, __( 'Sorry, no such post.' ) ); + } - if ( !current_user_can('delete_post', $post_ID) ) - return new IXR_Error(401, __('Sorry, you do not have the right to delete this post.')); + if ( ! current_user_can( 'delete_post', $post_ID ) ) { + return new IXR_Error( 401, __( 'Sorry, you are not allowed to delete this post.' ) ); + } - $result = wp_delete_post($post_ID); + $result = wp_delete_post( $post_ID ); - if ( !$result ) - return new IXR_Error(500, __('For some strange yet very annoying reason, this post could not be deleted.')); + if ( ! $result ) { + return new IXR_Error( 500, __( 'The post cannot be deleted.' ) ); + } /** * Fires after a post has been successfully deleted via the XML-RPC Blogger API. @@ -4380,21 +4808,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; @@ -4426,7 +4857,7 @@ class wp_xmlrpc_server extends IXR_Server { $post_type = 'post'; } else { // No other post_type values are allowed here - return new IXR_Error( 401, __( 'Invalid post type' ) ); + return new IXR_Error( 401, __( 'Invalid post type.' ) ); } } else { if ( $publish ) @@ -4477,14 +4908,14 @@ class wp_xmlrpc_server extends IXR_Server { switch ( $post_type ) { case "post": if ( !current_user_can( 'edit_others_posts' ) ) - return new IXR_Error( 401, __( 'You are not allowed to create posts as this user.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to create posts as this user.' ) ); break; case "page": if ( !current_user_can( 'edit_others_pages' ) ) - return new IXR_Error( 401, __( 'You are not allowed to create pages as this user.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to create pages as this user.' ) ); break; default: - return new IXR_Error( 401, __( 'Invalid post type' ) ); + return new IXR_Error( 401, __( 'Invalid post type.' ) ); } $author = get_userdata( $content_struct['wp_author_id'] ); if ( ! $author ) @@ -4526,7 +4957,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 +4970,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 +4988,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 +5000,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 ) @@ -4598,8 +5029,8 @@ class wp_xmlrpc_server extends IXR_Server { $post_date = get_date_from_gmt(iso8601_to_datetime($dateCreated)); $post_date_gmt = iso8601_to_datetime($dateCreated, 'GMT'); } else { - $post_date = current_time('mysql'); - $post_date_gmt = current_time('mysql', 1); + $post_date = ''; + $post_date_gmt = ''; } $post_category = array(); @@ -4669,8 +5100,12 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * @param integer $post_ID - * @param array $enclosure + * Adds an enclosure to a post if it's new. + * + * @since 2.8.0 + * + * @param integer $post_ID Post ID. + * @param array $enclosure Enclosure data. */ public function add_enclosure_if_new( $post_ID, $enclosure ) { if ( is_array( $enclosure ) && isset( $enclosure['url'] ) && isset( $enclosure['length'] ) && isset( $enclosure['type'] ) ) { @@ -4695,6 +5130,8 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.1.0 * + * @global wpdb $wpdb WordPress database abstraction object. + * * @param int $post_ID Post ID. * @param string $post_content Post Content for attachment. */ @@ -4716,12 +5153,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,18 +5181,19 @@ 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.' ) ); if ( ! current_user_can( 'edit_post', $post_ID ) ) - return new IXR_Error( 401, __( 'Sorry, you do not have the right to edit this post.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); // Use wp.editPost to edit post types other than post and page. if ( ! in_array( $postdata[ 'post_type' ], array( 'post', 'page' ) ) ) - return new IXR_Error( 401, __( 'Invalid post type' ) ); + return new IXR_Error( 401, __( 'Invalid post type.' ) ); // Thwart attempt to change the post type. if ( ! empty( $content_struct[ 'post_type' ] ) && ( $content_struct['post_type'] != $postdata[ 'post_type' ] ) ) @@ -4803,17 +5248,16 @@ class wp_xmlrpc_server extends IXR_Server { switch ( $post_type ) { case 'post': if ( ! current_user_can( 'edit_others_posts' ) ) { - return new IXR_Error( 401, __( 'You are not allowed to change the post author as this user.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to change the post author as this user.' ) ); } break; case 'page': if ( ! current_user_can( 'edit_others_pages' ) ) { - return new IXR_Error( 401, __( 'You are not allowed to change the page author as this user.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to change the page author as this user.' ) ); } break; default: - return new IXR_Error( 401, __( 'Invalid post type' ) ); - break; + return new IXR_Error( 401, __( 'Invalid post type.' ) ); } $post_author = $content_struct['wp_author_id']; } @@ -4829,7 +5273,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 +5286,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 +5302,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 +5314,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; } } @@ -4916,9 +5360,9 @@ class wp_xmlrpc_server extends IXR_Server { if ( 'publish' == $post_status || 'private' == $post_status ) { if ( 'page' == $post_type && ! current_user_can( 'publish_pages' ) ) { - return new IXR_Error( 401, __( 'Sorry, you do not have the right to publish this page.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to publish this page.' ) ); } elseif ( ! current_user_can( 'publish_posts' ) ) { - return new IXR_Error( 401, __( 'Sorry, you do not have the right to publish this post.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to publish this post.' ) ); } } @@ -4932,23 +5376,29 @@ 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(); + // Default to not flagging the post date to be edited unless it's intentional. + $edit_date = false; + if ( !empty( $dateCreated ) ) { $post_date = get_date_from_gmt(iso8601_to_datetime($dateCreated)); $post_date_gmt = iso8601_to_datetime($dateCreated, 'GMT'); + + // Flag the post date to be edited. + $edit_date = true; } else { $post_date = $postdata['post_date']; $post_date_gmt = $postdata['post_date_gmt']; } - // 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'); + // 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', 'edit_date', '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); if ( is_wp_error( $result ) ) @@ -4972,7 +5422,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 +5433,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 +5461,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; @@ -5030,7 +5486,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( !current_user_can( 'edit_post', $post_ID ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'metaWeblog.getPost' ); @@ -5043,7 +5499,7 @@ class wp_xmlrpc_server extends IXR_Server { $categories = array(); $catids = wp_get_post_categories($post_ID); - foreach($catids as $catid) + foreach ($catids as $catid) $categories[] = get_cat_name($catid); $tagnames = array(); @@ -5057,7 +5513,7 @@ class wp_xmlrpc_server extends IXR_Server { } $post = get_extended($postdata['post_content']); - $link = post_permalink($postdata['ID']); + $link = get_permalink($postdata['ID']); // Get the author info. $author = get_userdata($postdata['post_author']); @@ -5136,15 +5592,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 @@ -5154,7 +5616,7 @@ class wp_xmlrpc_server extends IXR_Server { return $this->error; if ( ! current_user_can( 'edit_posts' ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit posts on this site.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'metaWeblog.getRecentPosts' ); @@ -5176,7 +5638,7 @@ class wp_xmlrpc_server extends IXR_Server { $categories = array(); $catids = wp_get_post_categories($entry['ID']); - foreach( $catids as $catid ) + foreach ( $catids as $catid ) $categories[] = get_cat_name($catid); $tagnames = array(); @@ -5191,7 +5653,7 @@ class wp_xmlrpc_server extends IXR_Server { } $post = get_extended($entry['post_content']); - $link = post_permalink($entry['ID']); + $link = get_permalink($entry['ID']); // Get the post author info. $author = get_userdata($entry['post_author']); @@ -5248,15 +5710,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 +5763,24 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @global wpdb $wpdb WordPress database abstraction 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 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']; @@ -5317,12 +5793,17 @@ class wp_xmlrpc_server extends IXR_Server { do_action( 'xmlrpc_call', 'metaWeblog.newMediaObject' ); if ( !current_user_can('upload_files') ) { - $this->error = new IXR_Error( 401, __( 'You do not have permission to upload files.' ) ); + $this->error = new IXR_Error( 401, __( 'Sorry, you are not allowed to upload files.' ) ); + return $this->error; + } + + if ( is_multisite() && upload_is_user_over_quota( false ) ) { + $this->error = new IXR_Error( 401, __( 'Sorry, you have used your space allocation.' ) ); return $this->error; } /** - * Filter whether to preempt the XML-RPC media upload. + * Filters 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. @@ -5335,24 +5816,6 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 500, $upload_err ); } - if ( !empty($data['overwrite']) && ($data['overwrite'] == true) ) { - // Get postmeta info on the object. - $old_file = $wpdb->get_row(" - SELECT ID - FROM {$wpdb->posts} - WHERE post_title = '{$name}' - AND post_type = 'attachment' - "); - - // Delete previous file. - wp_delete_attachment($old_file->ID); - - // Make sure the new name is different by pre-pending the - // previous post id. - $filename = preg_replace('/^wpid\d+-/', '', $name); - $name = "wpid{$old_file->ID}-{$filename}"; - } - $upload = wp_upload_bits($name, null, $bits); if ( ! empty($upload['error']) ) { $errorString = sprintf(__('Could not write file %1$s (%2$s)'), $name, $upload['error']); @@ -5364,7 +5827,7 @@ class wp_xmlrpc_server extends IXR_Server { $post_id = (int) $data['post_id']; if ( ! current_user_can( 'edit_post', $post_id ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); } $attachment = array( 'post_title' => $name, @@ -5389,15 +5852,14 @@ class wp_xmlrpc_server extends IXR_Server { */ do_action( 'xmlrpc_call_success_mw_newMediaObject', $id, $args ); - $struct = array( - 'id' => strval( $id ), - 'file' => $name, - 'url' => $upload[ 'url' ], - 'type' => $type - ); + $struct = $this->_prepare_media_item( get_post( $id ) ); - /** This filter is documented in wp-admin/includes/file.php */ - return apply_filters( 'wp_handle_upload', $struct, 'upload' ); + // Deprecated values + $struct['id'] = $struct['attachment_id']; + $struct['file'] = $struct['title']; + $struct['url'] = $struct['link']; + + return $struct; } /* MovableType API functions @@ -5409,15 +5871,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 +5931,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 +5975,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; @@ -5520,7 +5998,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( !current_user_can( 'edit_post', $post_ID ) ) - return new IXR_Error( 401, __( 'Sorry, you can not edit this post.' ) ); + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'mt.getPostCategories' ); @@ -5546,17 +6024,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; @@ -5568,7 +6052,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( !current_user_can('edit_post', $post_ID) ) - return new IXR_Error(401, __('Sorry, you cannot edit this post.')); + return new IXR_Error(401, __('Sorry, you are not allowed to edit this post.')); $catids = array(); foreach ( $categories as $cat ) { @@ -5585,35 +6069,26 @@ 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' ); /** - * Filter the MoveableType text filters list for XML-RPC. + * Filters the MoveableType text filters list for XML-RPC. * * @since 2.2.0 * @@ -5627,15 +6102,14 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @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 +6144,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; @@ -5692,7 +6171,7 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); if ( !current_user_can('publish_posts') || !current_user_can('edit_post', $post_ID) ) - return new IXR_Error(401, __('Sorry, you cannot publish this post.')); + return new IXR_Error(401, __('Sorry, you are not allowed to publish this post.')); $postdata['post_status'] = 'publish'; @@ -5701,9 +6180,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,26 +6192,31 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @global wpdb $wpdb WordPress database abstraction object. + * @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. + * Filters the pingback source URI. * * @since 3.6.0 * @@ -5810,7 +6292,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( @@ -5822,35 +6304,37 @@ class wp_xmlrpc_server extends IXR_Server { 'X-Pingback-Forwarded-For' => $remote_ip, ), ); + $request = wp_safe_remote_get( $pagelinkedfrom, $http_api_args ); - $linea = wp_remote_retrieve_body( $request ); + $remote_source = $remote_source_original = wp_remote_retrieve_body( $request ); - if ( !$linea ) + if ( ! $remote_source ) { return $this->pingback_error( 16, __( 'The source URL does not exist.' ) ); + } /** - * Filter the pingback remote source. + * Filters 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. + * @param string $remote_source Response source for the page linked from. + * @param string $pagelinkedto URL of the page linked to. */ - $linea = apply_filters( 'pre_remote_source', $linea, $pagelinkedto ); + $remote_source = apply_filters( 'pre_remote_source', $remote_source, $pagelinkedto ); // Work around bug in strip_tags(): - $linea = str_replace(']*>/", "\n\n", $linea ); + $remote_source = str_replace( ']*>/", "\n\n", $remote_source ); - preg_match('|([^<]*?)|is', $linea, $matchtitle); + preg_match( '|([^<]*?)|is', $remote_source, $matchtitle ); $title = $matchtitle[1]; if ( empty( $title ) ) return $this->pingback_error( 32, __('We cannot find a title on that page.' ) ); - $linea = strip_tags( $linea, '' ); // just keep the tag we need + $remote_source = strip_tags( $remote_source, '' ); // just keep the tag we need - $p = explode( "\n\n", $linea ); + $p = explode( "\n\n", $remote_source ); $preg_target = preg_quote($pagelinkedto, '|'); @@ -5898,7 +6382,10 @@ class wp_xmlrpc_server extends IXR_Server { $this->escape($comment_content); $comment_type = 'pingback'; - $commentdata = compact('comment_post_ID', 'comment_author', 'comment_author_url', 'comment_author_email', 'comment_content', 'comment_type'); + $commentdata = compact( + 'comment_post_ID', 'comment_author', 'comment_author_url', 'comment_author_email', + 'comment_content', 'comment_type', 'remote_source', 'remote_source_original' + ); $comment_ID = wp_new_comment($commentdata); @@ -5921,19 +6408,18 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @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 ) { @@ -5963,12 +6449,17 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * @param integer $code - * @param string $message + * Sends a pingback error based on the given error code and message. + * + * @since 3.6.0 + * + * @param int $code Error code. + * @param string $message Error message. + * @return IXR_Error Error object. */ protected function pingback_error( $code, $message ) { /** - * Filter the XML-RPC pingback error return. + * Filters the XML-RPC pingback error return. * * @since 3.5.1 *