X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/8f374b7233bc2815ccc387e448d208c5434eb961..8d3bb1a5dcfdea9857d3c88c3751f09593e34dc8:/wp-includes/class-wp-xmlrpc-server.php?ds=inline diff --git a/wp-includes/class-wp-xmlrpc-server.php b/wp-includes/class-wp-xmlrpc-server.php index 7334a85d..be2d3edb 100644 --- a/wp-includes/class-wp-xmlrpc-server.php +++ b/wp-includes/class-wp-xmlrpc-server.php @@ -3,6 +3,7 @@ * XML-RPC protocol support for WordPress * * @package WordPress + * @subpackage Publishing */ /** @@ -12,27 +13,56 @@ * pingback. Additional WordPress API for managing comments, pages, posts, * options, etc. * - * Since WordPress 2.6.0, WordPress XMLRPC server can be disabled in the - * administration panels. + * As of WordPress 3.5.0, XML-RPC is enabled by default. It can be disabled + * via the {@see 'xmlrpc_enabled'} filter found in wp_xmlrpc_server::login(). * * @package WordPress * @subpackage Publishing * @since 1.5.0 */ 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 - * - * @return wp_xmlrpc_server */ - function __construct() { + public function __construct() { $this->methods = array( // WordPress API 'wp.getUsersBlogs' => 'this:wp_getUsersBlogs', @@ -48,6 +78,10 @@ class wp_xmlrpc_server extends IXR_Server { 'wp.getTerms' => 'this:wp_getTerms', 'wp.getTaxonomy' => 'this:wp_getTaxonomy', 'wp.getTaxonomies' => 'this:wp_getTaxonomies', + 'wp.getUser' => 'this:wp_getUser', + 'wp.getUsers' => 'this:wp_getUsers', + 'wp.getProfile' => 'this:wp_getProfile', + 'wp.editProfile' => 'this:wp_editProfile', 'wp.getPage' => 'this:wp_getPage', 'wp.getPages' => 'this:wp_getPages', 'wp.newPage' => 'this:wp_newPage', @@ -61,6 +95,7 @@ class wp_xmlrpc_server extends IXR_Server { 'wp.deleteCategory' => 'this:wp_deleteCategory', 'wp.suggestCategories' => 'this:wp_suggestCategories', 'wp.uploadFile' => 'this:mw_newMediaObject', // Alias + 'wp.deleteFile' => 'this:wp_deletePost', // Alias 'wp.getCommentCount' => 'this:wp_getCommentCount', 'wp.getPostStatusList' => 'this:wp_getPostStatusList', 'wp.getPageStatusList' => 'this:wp_getPageStatusList', @@ -78,14 +113,14 @@ class wp_xmlrpc_server extends IXR_Server { 'wp.getPostFormats' => 'this:wp_getPostFormats', 'wp.getPostType' => 'this:wp_getPostType', 'wp.getPostTypes' => 'this:wp_getPostTypes', + 'wp.getRevisions' => 'this:wp_getRevisions', + 'wp.restoreRevision' => 'this:wp_restoreRevision', // Blogger API 'blogger.getUsersBlogs' => 'this:blogger_getUsersBlogs', 'blogger.getUserInfo' => 'this:blogger_getUserInfo', 'blogger.getPost' => 'this:blogger_getPost', 'blogger.getRecentPosts' => 'this:blogger_getRecentPosts', - 'blogger.getTemplate' => 'this:blogger_getTemplate', - 'blogger.setTemplate' => 'this:blogger_setTemplate', 'blogger.newPost' => 'this:blogger_newPost', 'blogger.editPost' => 'this:blogger_editPost', 'blogger.deletePost' => 'this:blogger_deletePost', @@ -101,8 +136,6 @@ class wp_xmlrpc_server extends IXR_Server { // MetaWeblog API aliases for Blogger API // see http://www.xmlrpc.com/stories/storyReader$2460 'metaWeblog.deletePost' => 'this:blogger_deletePost', - 'metaWeblog.getTemplate' => 'this:blogger_getTemplate', - 'metaWeblog.setTemplate' => 'this:blogger_setTemplate', 'metaWeblog.getUsersBlogs' => 'this:blogger_getUsersBlogs', // MovableType API @@ -124,10 +157,43 @@ class wp_xmlrpc_server extends IXR_Server { ); $this->initialise_blog_option_info(); - $this->methods = apply_filters('xmlrpc_methods', $this->methods); + + /** + * Filters the methods exposed by the XML-RPC server. + * + * This filter can be used to add new methods, and remove built-in methods. + * + * @since 1.5.0 + * + * @param array $methods An array of XML-RPC methods. + */ + $this->methods = apply_filters( 'xmlrpc_methods', $this->methods ); + } + + /** + * 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 array|IXR_Error|false Return value of the callback, false otherwise. + */ + public function __call( $name, $arguments ) { + if ( '_multisite_getUsersBlogs' === $name ) { + return call_user_func_array( array( $this, $name ), $arguments ); + } + return false; } - function serve_request() { + /** + * Serves the XML-RPC request. + * + * @since 2.9.0 + * @access public + */ + public function serve_request() { $this->IXR_Server($this->methods); } @@ -136,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. */ - function sayHello($args) { + public function sayHello() { return 'Hello!'; } @@ -148,88 +213,129 @@ 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. */ - function addTwoNumbers($args) { + public function addTwoNumbers( $args ) { $number1 = $args[0]; $number2 = $args[1]; return $number1 + $number2; } /** - * Check user's credentials. + * Log user in. * - * @since 1.5.0 + * @since 2.8.0 * - * @param string $user_login User's username. - * @param string $user_pass User's password. - * @return bool Whether authentication passed. - * @deprecated use wp_xmlrpc_server::login - * @see wp_xmlrpc_server::login + * @param string $username User's username. + * @param string $password User's password. + * @return WP_User|bool WP_User object if authentication passed, false otherwise */ - function login_pass_ok($user_login, $user_pass) { - if ( !get_option( 'enable_xmlrpc' ) ) { - $this->error = new IXR_Error( 405, sprintf( __( 'XML-RPC services are disabled on this site. An admin user can enable them at %s'), admin_url('options-writing.php') ) ); + public function login( $username, $password ) { + /* + * Respect old get_option() filters left for back-compat when the 'enable_xmlrpc' + * option was deprecated in 3.5.0. Use the 'xmlrpc_enabled' hook instead. + */ + $enabled = apply_filters( 'pre_option_enable_xmlrpc', false ); + if ( false === $enabled ) { + $enabled = apply_filters( 'option_enable_xmlrpc', true ); + } + + /** + * 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. + * + * 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 + * + * @param bool $enabled Whether XML-RPC is enabled. Default true. + */ + $enabled = apply_filters( 'xmlrpc_enabled', $enabled ); + + if ( ! $enabled ) { + $this->error = new IXR_Error( 405, sprintf( __( 'XML-RPC services are disabled on this site.' ) ) ); return false; } - if (!user_pass_ok($user_login, $user_pass)) { - $this->error = new IXR_Error(403, __('Bad login/pass combination.')); + if ( $this->auth_failed ) { + $user = new WP_Error( 'login_prevented' ); + } else { + $user = wp_authenticate( $username, $password ); + } + + 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; + + /** + * Filters the XML-RPC user login error message. + * + * @since 3.5.0 + * + * @param string $error The XML-RPC error message. + * @param WP_User $user WP_User object. + */ + $this->error = apply_filters( 'xmlrpc_login_error', $this->error, $user ); return false; } - return true; + + wp_set_current_user( $user->ID ); + return $user; } /** - * Log user in. + * Check user's credentials. Deprecated. * - * @since 2.8 + * @since 1.5.0 + * @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. - * @return mixed WP_User object if authentication passed, false otherwise + * @return bool Whether authentication passed. */ - function login($username, $password) { - if ( !get_option( 'enable_xmlrpc' ) ) { - $this->error = new IXR_Error( 405, sprintf( __( 'XML-RPC services are disabled on this site. An admin user can enable them at %s'), admin_url('options-writing.php') ) ); - return false; - } - - $user = wp_authenticate($username, $password); - - if (is_wp_error($user)) { - $this->error = new IXR_Error(403, __('Bad login/pass combination.')); - return false; - } - - wp_set_current_user( $user->ID ); - return $user; + public function login_pass_ok( $username, $password ) { + return (bool) $this->login( $username, $password ); } /** - * Sanitize string or array of strings for database. + * Escape string or array of strings for database. * * @since 1.5.2 * - * @param string|array $array Sanitize single string or array of strings. - * @return string|array Type matches $array and sanitized for the database. + * @param string|array $data Escape single string or array of strings. + * @return string|void Returns with string is passed, alters by-reference + * when array is passed. */ - function escape(&$array) { - global $wpdb; - - if (!is_array($array)) { - return($wpdb->escape($array)); - } else { - foreach ( (array) $array as $k => $v ) { - if ( is_array($v) ) { - $this->escape($array[$k]); - } else if ( is_object($v) ) { - //skip - } else { - $array[$k] = $wpdb->escape($v); - } - } + public function escape( &$data ) { + if ( ! is_array( $data ) ) + return wp_slash( $data ); + + foreach ( $data as &$v ) { + if ( is_array( $v ) ) + $this->escape( $v ); + elseif ( ! is_object( $v ) ) + $v = wp_slash( $v ); } } @@ -241,7 +347,7 @@ class wp_xmlrpc_server extends IXR_Server { * @param int $post_id Post ID. * @return array Custom fields, if exist. */ - function get_custom_fields($post_id) { + public function get_custom_fields($post_id) { $post_id = (int) $post_id; $custom_fields = array(); @@ -269,7 +375,7 @@ class wp_xmlrpc_server extends IXR_Server { * @param int $post_id Post ID. * @param array $fields Custom fields. */ - function set_custom_fields($post_id, $fields) { + public function set_custom_fields($post_id, $fields) { $post_id = (int) $post_id; foreach ( (array) $fields as $meta ) { @@ -277,16 +383,16 @@ class wp_xmlrpc_server extends IXR_Server { $meta['id'] = (int) $meta['id']; $pmeta = get_metadata_by_mid( 'post', $meta['id'] ); if ( isset($meta['key']) ) { - $meta['key'] = stripslashes( $meta['key'] ); - if ( $meta['key'] != $pmeta->meta_key ) + $meta['key'] = wp_unslash( $meta['key'] ); + if ( $meta['key'] !== $pmeta->meta_key ) continue; - $meta['value'] = stripslashes_deep( $meta['value'] ); + $meta['value'] = wp_unslash( $meta['value'] ); if ( current_user_can( 'edit_post_meta', $post_id, $meta['key'] ) ) update_metadata_by_mid( 'post', $meta['id'], $meta['value'] ); } elseif ( current_user_can( 'delete_post_meta', $post_id, $pmeta->meta_key ) ) { delete_metadata_by_mid( 'post', $meta['id'] ); } - } elseif ( current_user_can( 'add_post_meta', $post_id, stripslashes( $meta['key'] ) ) ) { + } elseif ( current_user_can( 'add_post_meta', $post_id, wp_unslash( $meta['key'] ) ) ) { add_post_meta( $post_id, $meta['key'], $meta['value'] ); } } @@ -295,11 +401,13 @@ 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 */ - function initialise_blog_option_info() { + public function initialise_blog_option_info() { global $wp_version; $this->blog_options = array( @@ -315,10 +423,25 @@ class wp_xmlrpc_server extends IXR_Server { 'value' => $wp_version ), 'blog_url' => array( - 'desc' => __( 'Site URL' ), + 'desc' => __( 'WordPress Address (URL)' ), 'readonly' => true, 'option' => 'siteurl' ), + 'home_url' => array( + 'desc' => __( 'Site Address (URL)' ), + 'readonly' => true, + 'option' => 'home' + ), + 'login_url' => array( + 'desc' => __( 'Login Address (URL)' ), + 'readonly' => true, + 'value' => wp_login_url( ) + ), + 'admin_url' => array( + 'desc' => __( 'The URL to the admin area' ), + 'readonly' => true, + 'value' => get_admin_url( ) + ), 'image_default_link_type' => array( 'desc' => __( 'Image default link type' ), 'readonly' => true, @@ -406,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, @@ -422,12 +555,19 @@ 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' ) ); + /** + * Filters the XML-RPC blog options property. + * + * @since 2.6.0 + * + * @param array $blog_options An array of XML-RPC blog options. + */ $this->blog_options = apply_filters( 'xmlrpc_blog_options', $this->blog_options ); } @@ -436,18 +576,21 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.6.0 * - * @param array $args Method parameters. Contains: - * - username - * - password - * @return array. Contains: + * @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' * - 'xmlrpc' - url of xmlrpc endpoint */ - function wp_getUsersBlogs( $args ) { - global $current_site; + public function wp_getUsersBlogs( $args ) { // If this isn't on WPMU then just use blogger_getUsersBlogs if ( !is_multisite() ) { array_unshift( $args, 1 ); @@ -462,26 +605,46 @@ class wp_xmlrpc_server extends IXR_Server { if ( !$user = $this->login($username, $password) ) return $this->error; + /** + * Fires after the XML-RPC user has been authenticated but before the rest of + * the method logic begins. + * + * All built-in XML-RPC methods use the action xmlrpc_call, with a parameter + * equal to the method's name, e.g., wp.getUsersBlogs, wp.newPost, etc. + * + * @since 2.5.0 + * + * @param 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 - if ( $blog->site_id != $current_site->id ) + // Don't include blogs that aren't hosted at this site. + if ( $blog->site_id != get_current_site()->id ) continue; $blog_id = $blog->userblog_id; - switch_to_blog($blog_id); - $is_admin = current_user_can('manage_options'); + + 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' => get_option( 'home' ) . '/', - 'blogid' => (string) $blog_id, - 'blogName' => get_option( 'blogname' ), - 'xmlrpc' => site_url( 'xmlrpc.php' ) + '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(); @@ -494,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 ) { @@ -513,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( @@ -533,9 +697,21 @@ class wp_xmlrpc_server extends IXR_Server { if ( in_array( 'cap', $fields ) ) $_taxonomy['cap'] = (array) $taxonomy->cap; + if ( in_array( 'menu', $fields ) ) + $_taxonomy['show_in_menu'] = (bool) $_taxonomy->show_in_menu; + if ( in_array( 'object_type', $fields ) ) $_taxonomy['object_type'] = array_unique( (array) $taxonomy->object_type ); + /** + * Filters XML-RPC-prepared data for the given taxonomy. + * + * @since 3.4.0 + * + * @param array $_taxonomy An array of taxonomy data. + * @param object $taxonomy Taxonomy object. + * @param array $fields The subset of taxonomy fields to return. + */ return apply_filters( 'xmlrpc_prepare_taxonomy', $_taxonomy, $taxonomy, $fields ); } @@ -544,23 +720,31 @@ 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 Intergers which may be largeer than XMLRPC supports ensure we return strings. + // For integers which may be larger than XML-RPC supports ensure we return strings. $_term['term_id'] = strval( $_term['term_id'] ); $_term['term_group'] = strval( $_term['term_group'] ); $_term['term_taxonomy_id'] = strval( $_term['term_taxonomy_id'] ); $_term['parent'] = strval( $_term['parent'] ); - // Count we are happy to return as an Integer because people really shouldn't use Terms that much. + // Count we are happy to return as an integer because people really shouldn't use terms that much. $_term['count'] = intval( $_term['count'] ); + /** + * Filters XML-RPC-prepared data for the given term. + * + * @since 3.4.0 + * + * @param array $_term An array of term data. + * @param array|object $term Term object or array. + */ return apply_filters( 'xmlrpc_prepare_term', $_term, $term ); } @@ -569,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' ) { @@ -584,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' ) { @@ -600,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'] ), @@ -622,13 +806,17 @@ class wp_xmlrpc_server extends IXR_Server { 'post_password' => $post['post_password'], 'post_excerpt' => $post['post_excerpt'], 'post_content' => $post['post_content'], - 'link' => post_permalink( $post['ID'] ), + 'post_parent' => strval( $post['post_parent'] ), + 'post_mime_type' => $post['post_mime_type'], + 'link' => get_permalink( $post['ID'] ), + 'guid' => $post['guid'], + 'menu_order' => intval( $post['menu_order'] ), 'comment_status' => $post['comment_status'], 'ping_status' => $post['ping_status'], '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 ) { @@ -636,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 { @@ -678,17 +866,28 @@ class wp_xmlrpc_server extends IXR_Server { } } + /** + * Filters XML-RPC-prepared date for the given post. + * + * @since 3.4.0 + * + * @param array $_post An array of modified post data. + * @param array $post An array of post data. + * @param array $fields An array of post fields. + */ return apply_filters( 'xmlrpc_prepare_post', $_post, $post, $fields ); } /** * 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( @@ -720,6 +919,15 @@ class wp_xmlrpc_server extends IXR_Server { if ( in_array( 'taxonomies', $fields ) ) $_post_type['taxonomies'] = get_object_taxonomies( $post_type->name, 'names' ); + /** + * 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 WP_Post_Type $post_type Post type object. + */ return apply_filters( 'xmlrpc_prepare_post_type', $_post_type, $post_type ); } @@ -728,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( @@ -742,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 ); @@ -750,6 +959,15 @@ class wp_xmlrpc_server extends IXR_Server { else $_media_item['thumbnail'] = $_media_item['link']; + /** + * Filters XML-RPC-prepared data for the given media item. + * + * @since 3.4.0 + * + * @param array $_media_item An array of media item data. + * @param object $media_item Media item object. + * @param string $thumbnail_size Image size. + */ return apply_filters( 'xmlrpc_prepare_media_item', $_media_item, $media_item, $thumbnail_size ); } @@ -758,18 +976,18 @@ 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 = ""; if ( ! empty( $page->post_parent ) ) { - $parent = get_page( $page->post_parent ); + $parent = get_post( $page->post_parent ); $parent_title = $parent->post_title; } @@ -783,8 +1001,10 @@ class wp_xmlrpc_server extends IXR_Server { // Pull the categories info together. $categories = array(); - foreach ( wp_get_post_categories( $page->ID ) as $cat_id ) { - $categories[] = get_cat_name( $cat_id ); + if ( is_object_in_taxonomy( 'page', 'category' ) ) { + foreach ( wp_get_post_categories( $page->ID ) as $cat_id ) { + $categories[] = get_cat_name( $cat_id ); + } } // Get the author info. @@ -821,6 +1041,14 @@ class wp_xmlrpc_server extends IXR_Server { 'wp_page_template' => $page_template ); + /** + * Filters XML-RPC-prepared data for the given page. + * + * @since 3.4.0 + * + * @param array $_page An array of page data. + * @param WP_Post $page Page object. + */ return apply_filters( 'xmlrpc_prepare_page', $_page, $page ); } @@ -829,23 +1057,22 @@ 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. - $comment_date = $this->_convert_date( $comment->comment_date ); $comment_date_gmt = $this->_convert_date_gmt( $comment->comment_date_gmt, $comment->comment_date ); - if ( '0' == $comment->comment_approved ) + if ( '0' == $comment->comment_approved ) { $comment_status = 'hold'; - else if ( 'spam' == $comment->comment_approved ) + } elseif ( 'spam' == $comment->comment_approved ) { $comment_status = 'spam'; - else if ( '1' == $comment->comment_approved ) + } elseif ( '1' == $comment->comment_approved ) { $comment_status = 'approve'; - else + } else { $comment_status = $comment->comment_approved; - + } $_comment = array( 'date_created_gmt' => $comment_date_gmt, 'user_id' => $comment->user_id, @@ -863,47 +1090,119 @@ class wp_xmlrpc_server extends IXR_Server { 'type' => $comment->comment_type, ); + /** + * Filters XML-RPC-prepared data for the given comment. + * + * @since 3.4.0 + * + * @param array $_comment An array of prepared comment data. + * @param WP_Comment $comment Comment object. + */ return apply_filters( 'xmlrpc_prepare_comment', $_comment, $comment ); } + /** + * Prepares user data for return in an XML-RPC object. + * + * @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. + */ + protected function _prepare_user( $user, $fields ) { + $_user = array( 'user_id' => strval( $user->ID ) ); + + $user_fields = array( + 'username' => $user->user_login, + 'first_name' => $user->user_firstname, + 'last_name' => $user->user_lastname, + 'registered' => $this->_convert_date( $user->user_registered ), + 'bio' => $user->user_description, + 'email' => $user->user_email, + 'nickname' => $user->nickname, + 'nicename' => $user->user_nicename, + 'url' => $user->user_url, + 'display_name' => $user->display_name, + 'roles' => $user->roles, + ); + + if ( in_array( 'all', $fields ) ) { + $_user = array_merge( $_user, $user_fields ); + } else { + if ( in_array( 'basic', $fields ) ) { + $basic_fields = array( 'username', 'email', 'registered', 'display_name', 'nicename' ); + $fields = array_merge( $fields, $basic_fields ); + } + $requested_fields = array_intersect_key( $user_fields, array_flip( $fields ) ); + $_user = array_merge( $_user, $requested_fields ); + } + + /** + * Filters XML-RPC-prepared data for the given user. + * + * @since 3.5.0 + * + * @param array $_user An array of user data. + * @param WP_User $user User object. + * @param array $fields An array of user fields. + */ + return apply_filters( 'xmlrpc_prepare_user', $_user, $user, $fields ); + } + /** * Create a new post for any registered post type. * * @since 3.4.0 * - * @param array $args Method parameters. Contains: - * - int $blog_id - * - string $username - * - string $password - * - array $content_struct - * $content_struct can contain: - * - post_type (default: 'post') - * - post_status (default: 'draft') - * - post_title - * - post_author - * - post_exerpt - * - 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 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. */ - function wp_newPost( $args ) { + public function wp_newPost( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $content_struct = $args[3]; @@ -911,6 +1210,22 @@ class wp_xmlrpc_server extends IXR_Server { if ( ! $user = $this->login( $username, $password ) ) return $this->error; + // convert the date field back to IXR form + if ( isset( $content_struct['post_date'] ) && ! ( $content_struct['post_date'] instanceof IXR_Date ) ) { + $content_struct['post_date'] = $this->_convert_date( $content_struct['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 + if ( isset( $content_struct['post_date_gmt'] ) && ! ( $content_struct['post_date_gmt'] instanceof IXR_Date ) ) { + if ( $content_struct['post_date_gmt'] == '0000-00-00 00:00:00' || isset( $content_struct['post_date'] ) ) { + unset( $content_struct['post_date_gmt'] ); + } else { + $content_struct['post_date_gmt'] = $this->_convert_date( $content_struct['post_date_gmt'] ); + } + } + + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.newPost' ); unset( $content_struct['ID'] ); @@ -930,13 +1245,54 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * Helper method for wp_newPost and wp_editPost, containing shared logic. + * Encapsulate the logic for sticking a post + * and determining if the user has permission to do so + * + * @since 4.3.0 + * @access private + * + * @param array $post_data + * @param bool $update + * @return void|IXR_Error + */ + private function _toggle_sticky( $post_data, $update = false ) { + $post_type = get_post_type_object( $post_data['post_type'] ); + + // Private and password-protected posts cannot be stickied. + if ( 'private' === $post_data['post_status'] || ! empty( $post_data['post_password'] ) ) { + // Error if the client tried to stick the post, otherwise, silently unstick. + if ( ! empty( $post_data['sticky'] ) ) { + return new IXR_Error( 401, __( 'Sorry, you cannot stick a private post.' ) ); + } + + if ( $update ) { + unstick_post( $post_data['ID'] ); + } + } elseif ( isset( $post_data['sticky'] ) ) { + if ( ! current_user_can( $post_type->cap->edit_others_posts ) ) { + return new IXR_Error( 401, __( 'Sorry, you are not allowed to stick this post.' ) ); + } + + $sticky = wp_validate_boolean( $post_data['sticky'] ); + if ( $sticky ) { + stick_post( $post_data['ID'] ); + } else { + unstick_post( $post_data['ID'] ); + } + } + } + + /** + * Helper method for wp_newPost() and wp_editPost(), containing shared logic. * * @since 3.4.0 - * @uses wp_insert_post() + * @access protected + * + * @see wp_insert_post() * - * @param WP_User $user The post author if post_author isn't set in $content_struct. - * @param array $content_struct Post data to insert. + * @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, @@ -946,19 +1302,19 @@ 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'] ); if ( $update ) { if ( ! get_post( $post_data['ID'] ) ) return new IXR_Error( 401, __( 'Invalid post ID.' ) ); - if ( ! current_user_can( $post_type->cap->edit_post, $post_data['ID'] ) ) + if ( ! current_user_can( 'edit_post', $post_data['ID'] ) ) return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); if ( $post_data['post_type'] != get_post_type( $post_data['ID'] ) ) return new IXR_Error( 401, __( 'The post type may not be changed.' ) ); } else { - if ( ! current_user_can( $post_type->cap->edit_posts ) ) + if ( ! current_user_can( $post_type->cap->create_posts ) || ! current_user_can( $post_type->cap->edit_posts ) ) return new IXR_Error( 401, __( 'Sorry, you are not allowed to post on this site.' ) ); } @@ -976,7 +1332,8 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 401, __( 'Sorry, you are not allowed to publish posts in this post type' ) ); break; default: - $post_data['post_status'] = 'draft'; + if ( ! get_post_status_object( $post_data['post_status'] ) ) + $post_data['post_status'] = 'draft'; break; } @@ -986,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'] ); @@ -1002,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'] ) ) @@ -1020,29 +1383,19 @@ class wp_xmlrpc_server extends IXR_Server { $post_ID = $post_data['ID']; if ( $post_data['post_type'] == 'post' ) { - // Private and password-protected posts cannot be stickied. - if ( $post_data['post_status'] == 'private' || ! empty( $post_data['post_password'] ) ) { - // Error if the client tried to stick the post, otherwise, silently unstick. - if ( ! empty( $post_data['sticky'] ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot stick a private post.' ) ); - if ( $update ) - unstick_post( $post_ID ); - } elseif ( isset( $post_data['sticky'] ) ) { - if ( ! current_user_can( $post_type->cap->edit_others_posts ) ) - return new IXR_Error( 401, __( 'Sorry, you are not allowed to stick this post.' ) ); - if ( $post_data['sticky'] ) - stick_post( $post_ID ); - else - unstick_post( $post_ID ); + $error = $this->_toggle_sticky( $post_data, $update ); + if ( $error ) { + return $error; } } 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 ( ! set_post_thumbnail( $post_ID, $post_data['post_thumbnail'] ) ) - return new IXR_Error( 404, __( 'Invalid attachment ID.' ) ); + elseif ( ! get_post( absint( $post_data['post_thumbnail'] ) ) ) + return new IXR_Error( 404, __( 'Invalid attachment ID.' ) ); + set_post_thumbnail( $post_ID, $post_data['post_thumbnail'] ); unset( $content_struct['post_thumbnail'] ); } @@ -1052,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.' ) ); @@ -1068,18 +1421,19 @@ class wp_xmlrpc_server extends IXR_Server { return new IXR_Error( 401, __( 'Sorry, you are not allowed to assign a term to one of the given taxonomies.' ) ); $term_ids = $post_data['terms'][$taxonomy]; + $terms[ $taxonomy ] = array(); foreach ( $term_ids as $term_id ) { $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'] ); @@ -1090,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 ); @@ -1112,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() ); @@ -1132,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'] ); } @@ -1145,15 +1502,23 @@ 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'] ); + /** + * Filters post data array to be inserted via XML-RPC. + * + * @since 3.4.0 + * + * @param array $post_data Parsed array of post data. + * @param array $content_struct Post data array. + */ $post_data = apply_filters( 'xmlrpc_wp_insert_post_data', $post_data, $content_struct ); - $post_ID = wp_insert_post( $post_data, true ); + $post_ID = $update ? wp_update_post( $post_data, true ) : wp_insert_post( $post_data, true ); if ( is_wp_error( $post_ID ) ) return new IXR_Error( 500, $post_ID->get_error_message() ); @@ -1171,21 +1536,23 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @param array $args Method parameters. Contains: - * - int $blog_id - * - string $username - * - string $password - * - int $post_id - * - array $content_struct - * @return 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. */ - function wp_editPost( $args ) { + public function wp_editPost( $args ) { if ( ! $this->minimum_args( $args, 5 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $post_id = (int) $args[3]; @@ -1194,6 +1561,7 @@ class wp_xmlrpc_server extends IXR_Server { if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.editPost' ); $post = get_post( $post_id, ARRAY_A ); @@ -1201,11 +1569,20 @@ class wp_xmlrpc_server extends IXR_Server { if ( empty( $post['ID'] ) ) return new IXR_Error( 404, __( 'Invalid post ID.' ) ); - // convert the date field back to IXR form + if ( isset( $content_struct['if_not_modified_since'] ) ) { + // If the post has been modified since the date provided, return an error. + if ( mysql2date( 'U', $post['post_modified_gmt'] ) > $content_struct['if_not_modified_since']->getTimestamp() ) { + return new IXR_Error( 409, __( 'There is a revision of this post that is more recent.' ) ); + } + } + + // 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 @@ -1226,21 +1603,24 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses wp_delete_post() - * @param array $args Method parameters. Contains: - * - int $blog_id - * - string $username - * - string $password - * - int $post_id - * @return 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. */ - function wp_deletePost( $args ) { + public function wp_deletePost( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $post_id = (int) $args[3]; @@ -1248,20 +1628,23 @@ class wp_xmlrpc_server extends IXR_Server { if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.deletePost' ); - $post = wp_get_single_post( $post_id, ARRAY_A ); - if ( empty( $post['ID'] ) ) + $post = get_post( $post_id, ARRAY_A ); + if ( empty( $post['ID'] ) ) { return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + } - $post_type = get_post_type_object( $post['post_type'] ); - if ( ! current_user_can( $post_type->cap->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; } @@ -1280,13 +1663,18 @@ class wp_xmlrpc_server extends IXR_Server { * groups are 'post' (all basic fields), 'taxonomies', 'custom_fields', * and 'enclosure'. * - * @uses wp_get_single_post() - * @param array $args Method parameters. Contains: - * - int $post_id - * - string $username - * - string $password - * - array $fields optional - * @return array contains (based on $fields parameter): + * @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' * - 'post_date' @@ -1310,35 +1698,43 @@ class wp_xmlrpc_server extends IXR_Server { * - 'tags' * - 'enclosure' */ - function wp_getPost( $args ) { + public function wp_getPost( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; - $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] ) ) + if ( isset( $args[4] ) ) { $fields = $args[4]; - else + } else { + /** + * 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. 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' ); + } if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getPost' ); - $post = wp_get_single_post( $post_id, ARRAY_A ); + $post = get_post( $post_id, ARRAY_A ); if ( empty( $post['ID'] ) ) return new IXR_Error( 404, __( 'Invalid post ID.' ) ); - $post_type = get_post_type_object( $post['post_type'] ); - if ( ! current_user_can( $post_type->cap->edit_posts, $post_id ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) ); + if ( ! current_user_can( 'edit_post', $post_id ) ) + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); return $this->_prepare_post( $post, $fields ); } @@ -1348,44 +1744,44 @@ 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 - * - string $username - * - string $password - * - array $filter optional - * - array $fields optional - * @return array contains a collection of posts. + * @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. */ - function wp_getPosts( $args ) { + public function wp_getPosts( $args ) { if ( ! $this->minimum_args( $args, 3 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; - $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] ) ) + if ( isset( $args[4] ) ) { $fields = $args[4]; - else + } else { + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ $fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPosts' ); + } if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getPosts' ); $query = array(); @@ -1394,12 +1790,14 @@ class wp_xmlrpc_server extends IXR_Server { $post_type = get_post_type_object( $filter['post_type'] ); if ( ! ( (bool) $post_type ) ) return new IXR_Error( 403, __( 'The post type specified is not valid' ) ); + } else { + $post_type = get_post_type_object( 'post' ); + } - 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' )); + 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.' )); - $query['post_type'] = $filter['post_type']; - } + $query['post_type'] = $post_type->name; if ( isset( $filter['post_status'] ) ) $query['post_status'] = $filter['post_status']; @@ -1417,17 +1815,20 @@ class wp_xmlrpc_server extends IXR_Server { $query['order'] = $filter['order']; } + if ( isset( $filter['s'] ) ) { + $query['s'] = $filter['s']; + } + $posts_list = wp_get_recent_posts( $query ); if ( ! $posts_list ) return array(); - // holds all the posts data + // Holds all the posts data. $struct = array(); foreach ( $posts_list as $post ) { - $post_type = get_post_type_object( $post['post_type'] ); - if ( ! current_user_can( $post_type->cap->edit_posts, $post['ID'] ) ) + if ( ! current_user_can( 'edit_post', $post['ID'] ) ) continue; $struct[] = $this->_prepare_post( $post, $fields ); @@ -1441,44 +1842,43 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses wp_insert_term() - * @param array $args Method parameters. Contains: - * - int $blog_id - * - string $username - * - string $password - * - array $content_struct - * The $content_struct must contain: - * - 'name' - * - 'taxonomy' - * Also, it can optionally contain: - * - 'parent' - * - 'description' - * - 'slug' - * @return string 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. */ - function wp_newTerm( $args ) { + public function wp_newTerm( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; - $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; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ 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; @@ -1527,46 +1927,45 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses wp_update_term() - * @param array $args Method parameters. Contains: - * - int $blog_id - * - 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 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. */ - function wp_editTerm( $args ) { + public function wp_editTerm( $args ) { if ( ! $this->minimum_args( $args, 5 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; - $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; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ 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; @@ -1579,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'] ); @@ -1588,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." ) ); @@ -1626,22 +2025,25 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses wp_delete_term() - * @param array $args Method parameters. Contains: - * - int $blog_id - * - 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. */ - function wp_deleteTerm( $args ) { + public function wp_deleteTerm( $args ) { if ( ! $this->minimum_args( $args, 5 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $taxonomy = $args[3]; @@ -1650,15 +2052,16 @@ class wp_xmlrpc_server extends IXR_Server { if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.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 ); @@ -1666,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 ); @@ -1684,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 - * - string $username - * - string $password - * - string $taxonomy - * - string $term_id - * @return 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' @@ -1702,13 +2109,12 @@ class wp_xmlrpc_server extends IXR_Server { * - 'parent' * - 'count' */ - function wp_getTerm( $args ) { + public function wp_getTerm( $args ) { if ( ! $this->minimum_args( $args, 5 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $taxonomy = $args[3]; @@ -1717,15 +2123,16 @@ class wp_xmlrpc_server extends IXR_Server { if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.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 ); @@ -1733,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 ); } @@ -1746,22 +2153,26 @@ 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 - * - string $username - * - string $password - * - string $taxonomy - * - array $filter optional - * @return array 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. */ - function wp_getTerms( $args ) { + public function wp_getTerms( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $taxonomy = $args[3]; @@ -1770,15 +2181,16 @@ class wp_xmlrpc_server extends IXR_Server { if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.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(); @@ -1822,42 +2234,58 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses get_taxonomy() - * @param array $args Method parameters. Contains: - * - int $blog_id - * - string $username - * - string $password - * - string $taxonomy - * @return array (@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. */ - function wp_getTaxonomy( $args ) { + public function wp_getTaxonomy( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; - $username = $args[1]; - $password = $args[2]; - $taxonomy = $args[3]; + $username = $args[1]; + $password = $args[2]; + $taxonomy = $args[3]; - if ( isset( $args[4] ) ) + if ( isset( $args[4] ) ) { $fields = $args[4]; - else + } else { + /** + * Filters the taxonomy query fields used by the given XML-RPC method. + * + * @since 3.4.0 + * + * @param array $fields An array of taxonomy fields to retrieve. + * @param string $method The method name. + */ $fields = apply_filters( 'xmlrpc_default_taxonomy_fields', array( 'labels', 'cap', 'object_type' ), 'wp.getTaxonomy' ); + } if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getTaxonomy' ); 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 ); } @@ -1867,32 +2295,41 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses get_taxonomies() - * @param array $args Method parameters. Contains: - * - int $blog_id - * - 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. */ - function wp_getTaxonomies( $args ) { + public function wp_getTaxonomies( $args ) { if ( ! $this->minimum_args( $args, 3 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; - $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] ) ) + if ( isset( $args[4] ) ) { $fields = $args[4]; - else + } else { + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ $fields = apply_filters( 'xmlrpc_default_taxonomy_fields', array( 'labels', 'cap', 'object_type' ), 'wp.getTaxonomies' ); + } if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getTaxonomies' ); $taxonomies = get_taxonomies( $filter, 'objects' ); @@ -1912,75 +2349,364 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * Retrieve page. + * Retrieve a user. * - * @since 2.2.0 + * The optional $fields parameter specifies what fields will be included + * in the response array. This should be a list of field names. 'user_id' will + * always be included in the response regardless of the value of $fields. * - * @param array $args Method parameters. Contains: - * - blog_id - * - page_id - * - username - * - password - * @return array + * Instead of, or in addition to, individual field names, conceptual group + * names can be used to specify multiple fields. The available conceptual + * groups are 'basic' and 'all'. + * + * @uses get_userdata() + * + * @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' + * - 'first_name' + * - 'last_name' + * - 'registered' + * - 'bio' + * - 'email' + * - 'nickname' + * - 'nicename' + * - 'url' + * - 'display_name' + * - 'roles' */ - function wp_getPage($args) { - $this->escape($args); + public function wp_getUser( $args ) { + if ( ! $this->minimum_args( $args, 4 ) ) + return $this->error; + + $this->escape( $args ); - $blog_id = (int) $args[0]; - $page_id = (int) $args[1]; - $username = $args[2]; - $password = $args[3]; + $username = $args[1]; + $password = $args[2]; + $user_id = (int) $args[3]; - if ( !$user = $this->login($username, $password) ) { - return $this->error; + if ( isset( $args[4] ) ) { + $fields = $args[4]; + } else { + /** + * Filters the default user query fields used by the given XML-RPC method. + * + * @since 3.5.0 + * + * @param array $fields User query fields for given method. Default 'all'. + * @param string $method The method name. + */ + $fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUser' ); } - $page = get_page($page_id); - if ( ! $page ) - return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + if ( ! $user = $this->login( $username, $password ) ) + return $this->error; - if ( !current_user_can( 'edit_page', $page_id ) ) - return new IXR_Error( 401, __( 'Sorry, you cannot edit this page.' ) ); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getUser' ); - do_action('xmlrpc_call', 'wp.getPage'); + if ( ! current_user_can( 'edit_user', $user_id ) ) + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this user.' ) ); - // If we found the page then format the data. - if ( $page->ID && ($page->post_type == 'page') ) { - return $this->_prepare_page( $page ); - } - // If the page doesn't exist indicate that. - else { - return(new IXR_Error(404, __('Sorry, no such page.'))); - } + $user_data = get_userdata( $user_id ); + + if ( ! $user_data ) + return new IXR_Error( 404, __( 'Invalid user ID.' ) ); + + return $this->_prepare_user( $user_data, $fields ); } /** - * Retrieve Pages. + * Retrieve users. * - * @since 2.2.0 + * The optional $filter parameter modifies the query used to retrieve users. + * Accepted keys are 'number' (default: 50), 'offset' (default: 0), 'role', + * 'who', 'orderby', and 'order'. * - * @param array $args Method parameters. Contains: - * - blog_id - * - username - * - password - * - num_pages - * @return array + * The optional $fields parameter specifies what fields will be included + * in the response array. + * + * @uses get_users() + * @see wp_getUser() for more on $fields and return values + * + * @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 */ - function wp_getPages($args) { - $this->escape($args); + public function wp_getUsers( $args ) { + if ( ! $this->minimum_args( $args, 3 ) ) + return $this->error; - $blog_id = (int) $args[0]; - $username = $args[1]; - $password = $args[2]; - $num_pages = isset($args[3]) ? (int) $args[3] : 10; + $this->escape( $args ); + + $username = $args[1]; + $password = $args[2]; + $filter = isset( $args[3] ) ? $args[3] : array(); + + if ( isset( $args[4] ) ) { + $fields = $args[4]; + } else { + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + $fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUsers' ); + } + + if ( ! $user = $this->login( $username, $password ) ) + return $this->error; + + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getUsers' ); + + if ( ! current_user_can( 'list_users' ) ) + return new IXR_Error( 401, __( 'Sorry, you are not allowed to browse users.' ) ); + + $query = array( 'fields' => 'all_with_meta' ); + + $query['number'] = ( isset( $filter['number'] ) ) ? absint( $filter['number'] ) : 50; + $query['offset'] = ( isset( $filter['offset'] ) ) ? absint( $filter['offset'] ) : 0; + + if ( isset( $filter['orderby'] ) ) { + $query['orderby'] = $filter['orderby']; + + if ( isset( $filter['order'] ) ) + $query['order'] = $filter['order']; + } + + if ( isset( $filter['role'] ) ) { + if ( get_role( $filter['role'] ) === null ) + return new IXR_Error( 403, __( 'The role specified is not valid' ) ); + + $query['role'] = $filter['role']; + } + + if ( isset( $filter['who'] ) ) { + $query['who'] = $filter['who']; + } + + $users = get_users( $query ); + + $_users = array(); + foreach ( $users as $user_data ) { + if ( current_user_can( 'edit_user', $user_data->ID ) ) + $_users[] = $this->_prepare_user( $user_data, $fields ); + } + return $_users; + } + + /** + * Retrieve information about the requesting user. + * + * @uses get_userdata() + * + * @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 ) { + if ( ! $this->minimum_args( $args, 3 ) ) + return $this->error; + + $this->escape( $args ); + + $username = $args[1]; + $password = $args[2]; + + if ( isset( $args[3] ) ) { + $fields = $args[3]; + } else { + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + $fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getProfile' ); + } + + if ( ! $user = $this->login( $username, $password ) ) + return $this->error; + + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getProfile' ); + + if ( ! current_user_can( 'edit_user', $user->ID ) ) + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit your profile.' ) ); + + $user_data = get_userdata( $user->ID ); + + return $this->_prepare_user( $user_data, $fields ); + } + + /** + * Edit user's profile. + * + * @uses wp_update_user() + * + * @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' + * - 'display_name' + * - 'nickname' + * - 'nicename' + * - 'bio' + * } + * @return true|IXR_Error True, on success. + */ + public function wp_editProfile( $args ) { + if ( ! $this->minimum_args( $args, 4 ) ) + return $this->error; + + $this->escape( $args ); + + $username = $args[1]; + $password = $args[2]; + $content_struct = $args[3]; + + if ( ! $user = $this->login( $username, $password ) ) + return $this->error; + + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.editProfile' ); + + if ( ! current_user_can( 'edit_user', $user->ID ) ) + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit your profile.' ) ); + + // holds data of the user + $user_data = array(); + $user_data['ID'] = $user->ID; + + // only set the user details if it was given + if ( isset( $content_struct['first_name'] ) ) + $user_data['first_name'] = $content_struct['first_name']; + + if ( isset( $content_struct['last_name'] ) ) + $user_data['last_name'] = $content_struct['last_name']; + + if ( isset( $content_struct['url'] ) ) + $user_data['user_url'] = $content_struct['url']; + + if ( isset( $content_struct['display_name'] ) ) + $user_data['display_name'] = $content_struct['display_name']; + + if ( isset( $content_struct['nickname'] ) ) + $user_data['nickname'] = $content_struct['nickname']; + + if ( isset( $content_struct['nicename'] ) ) + $user_data['user_nicename'] = $content_struct['nicename']; + + if ( isset( $content_struct['bio'] ) ) + $user_data['description'] = $content_struct['bio']; + + $result = wp_update_user( $user_data ); + + if ( is_wp_error( $result ) ) + return new IXR_Error( 500, $result->get_error_message() ); + + if ( ! $result ) + return new IXR_Error( 500, __( 'Sorry, the user cannot be updated.' ) ); + + return true; + } + + /** + * Retrieve page. + * + * @since 2.2.0 + * + * @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 ); + + $page_id = (int) $args[1]; + $username = $args[2]; + $password = $args[3]; + + if ( !$user = $this->login($username, $password) ) { + return $this->error; + } + + $page = get_post($page_id); + if ( ! $page ) + return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + + if ( !current_user_can( 'edit_page', $page_id ) ) + 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' ); + + // If we found the page then format the data. + if ( $page->ID && ($page->post_type == 'page') ) { + return $this->_prepare_page( $page ); + } + // If the page doesn't exist indicate that. + else { + return new IXR_Error( 404, __( 'Sorry, no such page.' ) ); + } + } + + /** + * Retrieve Pages. + * + * @since 2.2.0 + * + * @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 ); + + $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.' ) ); - do_action('xmlrpc_call', 'wp.getPages'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getPages' ); $pages = get_posts( array('post_type' => 'page', 'post_status' => 'any', 'numberposts' => $num_pages) ); $num_pages = count($pages); @@ -1994,12 +2720,10 @@ class wp_xmlrpc_server extends IXR_Server { $pages_struct[] = $this->_prepare_page( $page ); } - return($pages_struct); - } - // If no pages were found return an error. - else { - return(array()); + return $pages_struct; } + + return array(); } /** @@ -2007,26 +2731,34 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()} - * @return unknown + * @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 */ - 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]); - $page = $args[3]; - $publish = $args[4]; + $username = $this->escape( $args[1] ); + $password = $this->escape( $args[2] ); if ( !$user = $this->login($username, $password) ) return $this->error; - do_action('xmlrpc_call', 'wp.newPage'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.newPage' ); // Mark this as content for a page. $args[3]["post_type"] = 'page'; // Let mw_newPost do all of the heavy lifting. - return($this->mw_newPost($args)); + return $this->mw_newPost( $args ); } /** @@ -2034,40 +2766,55 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. - * @return bool 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. */ - function wp_deletePage($args) { - $this->escape($args); + public function wp_deletePage( $args ) { + $this->escape( $args ); - $blog_id = (int) $args[0]; - $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; - do_action('xmlrpc_call', 'wp.deletePage'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.deletePage' ); // Get the current page based on the page_id and // make sure it is a page and not a post. - $actual_page = wp_get_single_post($page_id, ARRAY_A); + $actual_page = get_post($page_id, ARRAY_A); if ( !$actual_page || ($actual_page['post_type'] != 'page') ) - return(new IXR_Error(404, __('Sorry, no such page.'))); + return new IXR_Error( 404, __( 'Sorry, no such page.' ) ); // 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); if ( !$result ) - return(new IXR_Error(500, __('Failed to delete the page.'))); - + return new IXR_Error( 500, __( 'Failed to delete the page.' ) ); + + /** + * Fires after a page has been successfully deleted via XML-RPC. + * + * @since 3.4.0 + * + * @param int $page_id ID of the deleted page. + * @param array $args An array of arguments to delete the page. + */ do_action( 'xmlrpc_call_success_wp_deletePage', $page_id, $args ); - return(true); + return true; } /** @@ -2075,31 +2822,44 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. - * @return unknown + * @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 */ - function wp_editPage($args) { - // Items not escaped here will be escaped in editPost. - $blog_id = (int) $args[0]; - $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; + } - do_action('xmlrpc_call', 'wp.editPage'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.editPage' ); // Get the page data and make sure it is a page. - $actual_page = wp_get_single_post($page_id, ARRAY_A); + $actual_page = get_post($page_id, ARRAY_A); if ( !$actual_page || ($actual_page['post_type'] != 'page') ) - return(new IXR_Error(404, __('Sorry, no such page.'))); + return new IXR_Error( 404, __( 'Sorry, no such page.' ) ); // 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'; @@ -2114,7 +2874,7 @@ class wp_xmlrpc_server extends IXR_Server { ); // Let mw_editPost do all of the heavy lifting. - return($this->mw_editPost($args)); + return $this->mw_editPost( $args ); } /** @@ -2122,25 +2882,33 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. - * @return unknown + * @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 */ - function wp_getPageList($args) { + public function wp_getPageList( $args ) { global $wpdb; - $this->escape($args); + $this->escape( $args ); - $blog_id = (int) $args[0]; - $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.' ) ); - do_action('xmlrpc_call', 'wp.getPageList'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getPageList' ); // Get list of pages ids and titles $page_list = $wpdb->get_results(" @@ -2166,7 +2934,7 @@ class wp_xmlrpc_server extends IXR_Server { unset($page_list[$i]->post_status); } - return($page_list); + return $page_list; } /** @@ -2174,24 +2942,29 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_getAuthors($args) { - - $this->escape($args); + public function wp_getAuthors( $args ) { + $this->escape( $args ); - $blog_id = (int) $args[0]; - $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.' ) ); - do_action('xmlrpc_call', 'wp.getAuthors'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getAuthors' ); $authors = array(); foreach ( get_users( array( 'fields' => array('ID','user_login','display_name') ) ) as $user ) { @@ -2210,15 +2983,20 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_getTags( $args ) { + public function wp_getTags( $args ) { $this->escape( $args ); - $blog_id = (int) $args[0]; - $username = $args[1]; - $password = $args[2]; + $username = $args[1]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; @@ -2226,12 +3004,14 @@ class wp_xmlrpc_server extends IXR_Server { if ( !current_user_can( 'edit_posts' ) ) return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts on this site in order to view tags.' ) ); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getKeywords' ); $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; $struct['count'] = $tag->count; @@ -2251,25 +3031,32 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. - * @return int Category 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 array $category + * } + * @return int|IXR_Error Category ID. */ - function wp_newCategory($args) { - $this->escape($args); + public function wp_newCategory( $args ) { + $this->escape( $args ); - $blog_id = (int) $args[0]; - $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; - do_action('xmlrpc_call', 'wp.newCategory'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.newCategory' ); // Make sure the user is allowed to add a category. 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. @@ -2297,11 +3084,19 @@ class wp_xmlrpc_server extends IXR_Server { if ( 'term_exists' == $cat_id->get_error_code() ) return (int) $cat_id->get_error_data(); else - return(new IXR_Error(500, __('Sorry, the new category failed.'))); + return new IXR_Error(500, __('Sorry, the new category failed.')); } elseif ( ! $cat_id ) { - return(new IXR_Error(500, __('Sorry, the new category failed.'))); + return new IXR_Error(500, __('Sorry, the new category failed.')); } + /** + * Fires after a new category has been successfully created via XML-RPC. + * + * @since 3.4.0 + * + * @param int $cat_id ID of the new category. + * @param array $args An array of new category arguments. + */ do_action( 'xmlrpc_call_success_wp_newCategory', $cat_id, $args ); return $cat_id; @@ -2312,29 +3107,45 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param array $args Method parameters. - * @return mixed 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. */ - function wp_deleteCategory($args) { - $this->escape($args); + public function wp_deleteCategory( $args ) { + $this->escape( $args ); - $blog_id = (int) $args[0]; - $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; - do_action('xmlrpc_call', 'wp.deleteCategory'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.deleteCategory' ); if ( !current_user_can('manage_categories') ) - 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' ); - if( true == $status ) + if ( true == $status ) { + /** + * Fires after a category has been successfully deleted via XML-RPC. + * + * @since 3.4.0 + * + * @param int $category_id ID of the deleted category. + * @param array $args An array of arguments to delete the category. + */ do_action( 'xmlrpc_call_success_wp_deleteCategory', $category_id, $args ); + } return $status; } @@ -2344,25 +3155,33 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.2.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_suggestCategories($args) { - $this->escape($args); + public function wp_suggestCategories( $args ) { + $this->escape( $args ); - $blog_id = (int) $args[0]; - $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; if ( !current_user_can( 'edit_posts' ) ) - return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts to this site in order to view categories.' ) ); + return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts on this site in order to view categories.' ) ); - do_action('xmlrpc_call', 'wp.suggestCategories'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.suggestCategories' ); $category_suggestions = array(); $args = array('get' => 'all', 'number' => $max_results, 'name__like' => $category); @@ -2373,7 +3192,7 @@ class wp_xmlrpc_server extends IXR_Server { ); } - return($category_suggestions); + return $category_suggestions; } /** @@ -2381,27 +3200,37 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_getComment($args) { + public function wp_getComment($args) { $this->escape($args); - $blog_id = (int) $args[0]; $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.' ) ); - - do_action('xmlrpc_call', 'wp.getComment'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getComment' ); - if ( ! $comment = get_comment($comment_id) ) + 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 ); } @@ -2409,7 +3238,7 @@ class wp_xmlrpc_server extends IXR_Server { /** * Retrieve comments. * - * Besides the common blog_id, username, and password arguments, it takes a filter + * Besides the common blog_id (unused), username, and password arguments, it takes a filter * array as last argument. * * Accepted 'filter' keys are 'status', 'post_id', 'offset', and 'number'. @@ -2418,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. 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 */ - function wp_getComments($args) { - $this->escape($args); + public function wp_getComments( $args ) { + $this->escape( $args ); - $blog_id = (int) $args[0]; - $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.' ) ); - - do_action('xmlrpc_call', 'wp.getComments'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getComments' ); - if ( isset($struct['status']) ) + 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; @@ -2473,44 +3331,55 @@ 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 - * - username - * - password - * - comment_id - * @return mixed {@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(). */ - function wp_deleteComment($args) { + public function wp_deleteComment( $args ) { $this->escape($args); - $blog_id = (int) $args[0]; $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.' ) ); + } - do_action('xmlrpc_call', 'wp.deleteComment'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.deleteComment' ); $status = wp_delete_comment( $comment_ID ); - if( true == $status ) + if ( $status ) { + /** + * Fires after a comment has been successfully deleted via XML-RPC. + * + * @since 3.4.0 + * + * @param int $comment_ID ID of the deleted comment. + * @param array $args An array of arguments to delete the comment. + */ do_action( 'xmlrpc_call_success_wp_deleteComment', $comment_ID, $args ); + } return $status; } @@ -2518,7 +3387,7 @@ class wp_xmlrpc_server extends IXR_Server { /** * Edit comment. * - * Besides the common blog_id, username, and password arguments, it takes a + * Besides the common blog_id (unused), username, and password arguments, it takes a * comment_id integer and a content_struct array as last argument. * * The allowed keys in the content_struct array are: @@ -2527,40 +3396,43 @@ 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 - * - username - * - password - * - comment_id - * - content_struct - * @return bool 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. */ - function wp_editComment($args) { - $this->escape($args); + public function wp_editComment( $args ) { + $this->escape( $args ); - $blog_id = (int) $args[0]; $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.' ) ); + } - do_action('xmlrpc_call', 'wp.editComment'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.editComment' ); if ( isset($content_struct['status']) ) { $statuses = get_comment_statuses(); @@ -2601,6 +3473,14 @@ class wp_xmlrpc_server extends IXR_Server { if ( !$result ) return new IXR_Error(500, __('Sorry, the comment could not be edited. Something wrong happened.')); + /** + * Fires after a comment has been successfully updated via XML-RPC. + * + * @since 3.4.0 + * + * @param int $comment_ID ID of the updated comment. + * @param array $args An array of arguments to update the comment. + */ do_action( 'xmlrpc_call_success_wp_editComment', $comment_ID, $args ); return true; @@ -2611,30 +3491,44 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. - * @return mixed {@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(). */ - function wp_newComment($args) { - global $wpdb; - + public function wp_newComment($args) { $this->escape($args); - $blog_id = (int) $args[0]; - $username = $args[1]; - $password = $args[2]; - $post = $args[3]; + $username = $args[1]; + $password = $args[2]; + $post = $args[3]; $content_struct = $args[4]; - $allow_anon = apply_filters('xmlrpc_allow_anonymous_comments', false); + /** + * Filters whether to allow anonymous comments over XML-RPC. + * + * @since 2.7.0 + * + * @param bool $allow Whether to allow anonymous commenting via XML-RPC. + * Default false. + */ + $allow_anon = apply_filters( 'xmlrpc_allow_anonymous_comments', false ); $user = $this->login($username, $password); if ( !$user ) { $logged_in = false; - if ( $allow_anon && get_option('comment_registration') ) + if ( $allow_anon && get_option('comment_registration') ) { return new IXR_Error( 403, __( 'You must be registered to comment' ) ); - else if ( !$allow_anon ) + } elseif ( ! $allow_anon ) { return $this->error; + } } else { $logged_in = true; } @@ -2644,18 +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'] = $wpdb->escape( $user->display_name ); - $comment['comment_author_email'] = $wpdb->escape( $user->user_email ); - $comment['comment_author_url'] = $wpdb->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'] = ''; @@ -2684,10 +3589,19 @@ class wp_xmlrpc_server extends IXR_Server { $comment['comment_content'] = isset($content_struct['content']) ? $content_struct['content'] : null; - do_action('xmlrpc_call', 'wp.newComment'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.newComment' ); $comment_ID = wp_new_comment( $comment ); + /** + * Fires after a new comment has been successfully created via XML-RPC. + * + * @since 3.4.0 + * + * @param int $comment_ID ID of the new comment. + * @param array $args An array of new comment arguments. + */ do_action( 'xmlrpc_call_success_wp_newComment', $comment_ID, $args ); return $comment_ID; @@ -2698,23 +3612,31 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.7.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_getCommentStatusList($args) { + public function wp_getCommentStatusList( $args ) { $this->escape( $args ); - $blog_id = (int) $args[0]; - $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.' ) ); + } - do_action('xmlrpc_call', 'wp.getCommentStatusList'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getCommentStatusList' ); return get_comment_statuses(); } @@ -2724,26 +3646,41 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_getCommentCount( $args ) { - $this->escape($args); + public function wp_getCommentCount( $args ) { + $this->escape( $args ); - $blog_id = (int) $args[0]; $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.' ) ); + } - do_action('xmlrpc_call', 'wp.getCommentCount'); + 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, @@ -2757,23 +3694,29 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_getPostStatusList( $args ) { + public function wp_getPostStatusList( $args ) { $this->escape( $args ); - $blog_id = (int) $args[0]; - $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.' ) ); - do_action('xmlrpc_call', 'wp.getPostStatusList'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getPostStatusList' ); return get_post_statuses(); } @@ -2783,23 +3726,29 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.5.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_getPageStatusList( $args ) { + public function wp_getPageStatusList( $args ) { $this->escape( $args ); - $blog_id = (int) $args[0]; - $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.' ) ); - do_action('xmlrpc_call', 'wp.getPageStatusList'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getPageStatusList' ); return get_page_statuses(); } @@ -2809,21 +3758,26 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.6.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_getPageTemplates( $args ) { + public function wp_getPageTemplates( $args ) { $this->escape( $args ); - $blog_id = (int) $args[0]; - $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'; @@ -2836,13 +3790,19 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.6.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function wp_getOptions( $args ) { + public function wp_getOptions( $args ) { $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $options = isset( $args[3] ) ? (array) $args[3] : array(); @@ -2865,8 +3825,9 @@ class wp_xmlrpc_server extends IXR_Server { * @param array $options Options to retrieve. * @return array */ - function _getOptions($options) { + public function _getOptions($options) { $data = array(); + $can_manage = current_user_can( 'manage_options' ); foreach ( $options as $option ) { if ( array_key_exists( $option, $this->blog_options ) ) { $data[$option] = $this->blog_options[$option]; @@ -2875,6 +3836,9 @@ class wp_xmlrpc_server extends IXR_Server { $data[$option]['value'] = get_option( $data[$option]['option'] ); unset($data[$option]['option']); } + + if ( ! $can_manage ) + $data[$option]['readonly'] = true; } } @@ -2886,13 +3850,19 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 2.6.0 * - * @param array $args Method parameters. - * @return unknown + * @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 */ - function wp_setOptions( $args ) { + public function wp_setOptions( $args ) { $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $options = (array) $args[3]; @@ -2901,8 +3871,9 @@ 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 ) { $option_names[] = $o_name; if ( !array_key_exists( $o_name, $this->blog_options ) ) @@ -2911,7 +3882,7 @@ class wp_xmlrpc_server extends IXR_Server { if ( $this->blog_options[$o_name]['readonly'] == true ) continue; - update_option( $this->blog_options[$o_name]['option'], $o_value ); + update_option( $this->blog_options[$o_name]['option'], wp_unslash( $o_value ) ); } //Now return the updated values @@ -2923,12 +3894,15 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.1.0 * - * @param array $args Method parameters. Contains: - * - blog_id - * - username - * - password - * - attachment_id - * @return array. Associative array containing: + * @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' * - 'link' @@ -2938,10 +3912,9 @@ class wp_xmlrpc_server extends IXR_Server { * - 'description' * - 'metadata' */ - function wp_getMediaItem($args) { - $this->escape($args); + public function wp_getMediaItem( $args ) { + $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $attachment_id = (int) $args[3]; @@ -2950,9 +3923,10 @@ 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.' ) ); - do_action('xmlrpc_call', 'wp.getMediaItem'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getMediaItem' ); if ( ! $attachment = get_post($attachment_id) ) return new IXR_Error( 404, __( 'Invalid attachment ID.' ) ); @@ -2963,30 +3937,32 @@ class wp_xmlrpc_server extends IXR_Server { /** * Retrieves a collection of media library items (or attachments) * - * Besides the common blog_id, username, and password arguments, it takes a filter + * Besides the common blog_id (unused), username, and password arguments, it takes a filter * array as last argument. * * Accepted 'filter' keys are 'parent_id', 'mime_type', 'offset', and 'number'. * * 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 - * - username - * - password - * - filter - * @return array. 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 */ - function wp_getMediaLibrary($args) { + public function wp_getMediaLibrary($args) { $this->escape($args); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $struct = isset( $args[3] ) ? $args[3] : array() ; @@ -2995,9 +3971,10 @@ 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.' ) ); - do_action('xmlrpc_call', 'wp.getMediaLibrary'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getMediaLibrary' ); $parent_id = ( isset($struct['parent_id']) ) ? absint($struct['parent_id']) : '' ; $mime_type = ( isset($struct['mime_type']) ) ? $struct['mime_type'] : '' ; @@ -3015,20 +3992,22 @@ class wp_xmlrpc_server extends IXR_Server { } /** - * Retrieves a list of post formats used by the site - * - * @since 3.1 - * - * @param array $args Method parameters. Contains: - * - blog_id - * - username - * - password - * @return array - */ - function wp_getPostFormats( $args ) { + * 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 ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; @@ -3036,18 +4015,20 @@ 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' ); $formats = get_post_format_strings(); - # find out if they want a list of currently supports formats + // find out if they want a list of currently supports formats if ( isset( $args[3] ) && is_array( $args[3] ) ) { if ( $args[3]['show-supported'] ) { if ( current_theme_supports( 'post-formats' ) ) { $supported = get_theme_support( 'post-formats' ); + $data = array(); $data['all'] = $formats; $data['supported'] = $supported[0]; @@ -3064,14 +4045,18 @@ 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 - * - string $username - * - string $password - * - string $post_type_name - * - array $fields - * @return array contains: + * @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' * - 'capability_type' @@ -3082,33 +4067,42 @@ class wp_xmlrpc_server extends IXR_Server { * - 'taxonomies' * - 'supports' */ - function wp_getPostType( $args ) { + public function wp_getPostType( $args ) { if ( ! $this->minimum_args( $args, 4 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; $username = $args[1]; $password = $args[2]; $post_type_name = $args[3]; - if ( isset( $args[4] ) ) + if ( isset( $args[4] ) ) { $fields = $args[4]; - else + } else { + /** + * Filters the default query fields used by the given XML-RPC method. + * + * @since 3.4.0 + * + * @param array $fields An array of post type query fields for the given method. + * @param string $method The method name. + */ $fields = apply_filters( 'xmlrpc_default_posttype_fields', array( 'labels', 'cap', 'taxonomies' ), 'wp.getPostType' ); + } if ( !$user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getPostType' ); - 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 ); @@ -3119,42 +4113,48 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses get_post_types() - * @param array $args Method parameters. Contains: - * - int $blog_id - * - string $username - * - string $password - * - array $filter - * - array $fields - * @return array + * @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 */ - function wp_getPostTypes( $args ) { + public function wp_getPostTypes( $args ) { if ( ! $this->minimum_args( $args, 3 ) ) return $this->error; $this->escape( $args ); - $blog_id = (int) $args[0]; - $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] ) ) + if ( isset( $args[4] ) ) { $fields = $args[4]; - else + } else { + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ $fields = apply_filters( 'xmlrpc_default_posttype_fields', array( 'labels', 'cap', 'taxonomies' ), 'wp.getPostTypes' ); + } if ( ! $user = $this->login( $username, $password ) ) return $this->error; + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getPostTypes' ); $post_types = get_post_types( $filter, 'objects' ); $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 ); @@ -3163,8 +4163,145 @@ class wp_xmlrpc_server extends IXR_Server { return $struct; } + /** + * Retrieve revisions for a specific post. + * + * @since 3.5.0 + * + * The optional $fields parameter specifies what fields will be included + * in the response array. + * + * @uses wp_get_post_revisions() + * @see wp_getPost() for more on $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 ) { + if ( ! $this->minimum_args( $args, 4 ) ) + return $this->error; + + $this->escape( $args ); + + $username = $args[1]; + $password = $args[2]; + $post_id = (int) $args[3]; + + if ( isset( $args[4] ) ) { + $fields = $args[4]; + } else { + /** + * Filters the default revision query fields used by the given XML-RPC method. + * + * @since 3.5.0 + * + * @param array $field An array of revision query fields. + * @param string $method The method name. + */ + $fields = apply_filters( 'xmlrpc_default_revision_fields', array( 'post_date', 'post_date_gmt' ), 'wp.getRevisions' ); + } + + if ( ! $user = $this->login( $username, $password ) ) + return $this->error; + + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.getRevisions' ); + + if ( ! $post = get_post( $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.' ) ); + + // Check if revisions are enabled. + if ( ! wp_revisions_enabled( $post ) ) + return new IXR_Error( 401, __( 'Sorry, revisions are disabled.' ) ); + + $revisions = wp_get_post_revisions( $post_id ); + + if ( ! $revisions ) + return array(); + + $struct = array(); + + foreach ( $revisions as $revision ) { + if ( ! current_user_can( 'read_post', $revision->ID ) ) + continue; + + // Skip autosaves + if ( wp_is_post_autosave( $revision ) ) + continue; + + $struct[] = $this->_prepare_post( get_object_vars( $revision ), $fields ); + } + + return $struct; + } + + /** + * Restore a post revision + * + * @since 3.5.0 + * + * @uses wp_restore_post_revision() + * + * @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 ) { + if ( ! $this->minimum_args( $args, 3 ) ) + return $this->error; + + $this->escape( $args ); + + $username = $args[1]; + $password = $args[2]; + $revision_id = (int) $args[3]; + + if ( ! $user = $this->login( $username, $password ) ) + return $this->error; + + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'wp.restoreRevision' ); + + if ( ! $revision = wp_get_post_revision( $revision_id ) ) + return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + + if ( wp_is_post_autosave( $revision ) ) + return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + + if ( ! $post = get_post( $revision->post_parent ) ) + return new IXR_Error( 404, __( 'Invalid post ID.' ) ); + + if ( ! current_user_can( 'edit_post', $revision->post_parent ) ) + return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) ); + + // Check if revisions are disabled. + if ( ! wp_revisions_enabled( $post ) ) + return new IXR_Error( 401, __( 'Sorry, revisions are disabled.' ) ); + + $post = wp_restore_post_revision( $revision_id ); + + return (bool) $post; + } + /* 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/ */ /** @@ -3174,22 +4311,29 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - function blogger_getUsersBlogs($args) { + public function blogger_getUsersBlogs($args) { if ( is_multisite() ) return $this->_multisite_getUsersBlogs($args); $this->escape($args); $username = $args[1]; - $password = $args[2]; + $password = $args[2]; if ( !$user = $this->login($username, $password) ) return $this->error; - do_action('xmlrpc_call', 'blogger.getUsersBlogs'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'blogger.getUsersBlogs' ); $is_admin = current_user_can('manage_options'); @@ -3198,7 +4342,7 @@ class wp_xmlrpc_server extends IXR_Server { 'url' => get_option('home') . '/', 'blogid' => '1', 'blogName' => get_option('blogname'), - 'xmlrpc' => site_url( 'xmlrpc.php' ) + 'xmlrpc' => site_url( 'xmlrpc.php', 'rpc' ), ); return array($struct); @@ -3207,15 +4351,24 @@ 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 */ - function _multisite_getUsersBlogs($args) { - global $current_blog; + protected function _multisite_getUsersBlogs( $args ) { + $current_blog = get_blog_details(); + $domain = $current_blog->domain; $path = $current_blog->path . 'xmlrpc.php'; - $protocol = is_ssl() ? 'https' : 'http'; - $rpc = new IXR_Client("$protocol://{$domain}{$path}"); + $rpc = new IXR_Client( set_url_scheme( "http://{$domain}{$path}" ) ); $rpc->query('wp.getUsersBlogs', $args[1], $args[2]); $blogs = $rpc->getResponse(); @@ -3240,23 +4393,29 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - 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.' ) ); - do_action('xmlrpc_call', 'blogger.getUserInfo'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'blogger.getUserInfo' ); $struct = array( 'nickname' => $user->nickname, @@ -3274,34 +4433,41 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 1.5.0 * - * @param array $args Method parameters. - * @return array + * @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 */ - 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; - $post_data = wp_get_single_post($post_ID, ARRAY_A); + $post_data = get_post($post_ID, ARRAY_A); if ( ! $post_data ) 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.' ) ); - do_action('xmlrpc_call', 'blogger.getPost'); + /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ + do_action( 'xmlrpc_call', 'blogger.getPost' ); $categories = implode(',', wp_get_post_categories($post_ID)); - $content = '