X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/baca9ce86a38dc54c4574890ee2d352fd81f78b2..dc1231b7312fbdca99e9e887cc2bb35a28f85cdc:/wp-includes/class-wp-xmlrpc-server.php
diff --git a/wp-includes/class-wp-xmlrpc-server.php b/wp-includes/class-wp-xmlrpc-server.php
index e4a2d961..9121c07a 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,14 +13,37 @@
* 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 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;
/**
* Register all of the XMLRPC methods that XMLRPC server understands.
@@ -29,10 +53,8 @@ class wp_xmlrpc_server extends IXR_Server {
* or replace XMLRPC methods.
*
* @since 1.5.0
- *
- * @return wp_xmlrpc_server
*/
- function __construct() {
+ public function __construct() {
$this->methods = array(
// WordPress API
'wp.getUsersBlogs' => 'this:wp_getUsersBlogs',
@@ -65,6 +87,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',
@@ -126,10 +149,40 @@ class wp_xmlrpc_server extends IXR_Server {
);
$this->initialise_blog_option_info();
- $this->methods = apply_filters('xmlrpc_methods', $this->methods);
+
+ /**
+ * Filter the methods exposed by the XML-RPC server.
+ *
+ * This filter can be used to add new methods, and remove built-in methods.
+ *
+ * @since 1.5.0
+ *
+ * @param array $methods An array of XML-RPC methods.
+ */
+ $this->methods = apply_filters( 'xmlrpc_methods', $this->methods );
+ }
+
+ /**
+ * Make private/protected methods readable for backwards 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() {
+ /**
+ * @access public
+ */
+ public function serve_request() {
$this->IXR_Server($this->methods);
}
@@ -138,10 +191,9 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method Parameters.
- * @return string
+ * @return string Hello string response.
*/
- function sayHello($args) {
+ public function sayHello() {
return 'Hello!';
}
@@ -150,10 +202,15 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method Parameters.
- * @return int
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $number1 A number to add.
+ * @type int $number2 A second number to add.
+ * }
+ * @return int Sum of the two given numbers.
*/
- function addTwoNumbers($args) {
+ public function addTwoNumbers( $args ) {
$number1 = $args[0];
$number2 = $args[1];
return $number1 + $number2;
@@ -166,15 +223,27 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @param string $username User's username.
* @param string $password User's password.
- * @return mixed WP_User object if authentication passed, false otherwise
+ * @return WP_User|bool WP_User object if authentication passed, false otherwise
*/
- function login( $username, $password ) {
- // Respect any old filters against get_option() for 'enable_xmlrpc'.
- $enabled = apply_filters( 'pre_option_enable_xmlrpc', false ); // Deprecated
- if ( false === $enabled )
- $enabled = apply_filters( 'option_enable_xmlrpc', true ); // Deprecated
+ 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 );
+ }
- // Proper filter for turning off XML-RPC. It is on by default.
+ /**
+ * Filter whether XML-RPC is enabled.
+ *
+ * This is the proper filter for turning off XML-RPC.
+ *
+ * @since 3.5.0
+ *
+ * @param bool $enabled Whether XML-RPC is enabled. Default true.
+ */
$enabled = apply_filters( 'xmlrpc_enabled', $enabled );
if ( ! $enabled ) {
@@ -186,6 +255,15 @@ class wp_xmlrpc_server extends IXR_Server {
if (is_wp_error($user)) {
$this->error = new IXR_Error( 403, __( 'Incorrect username or password.' ) );
+
+ /**
+ * Filter the XML-RPC user login error message.
+ *
+ * @since 3.5.0
+ *
+ * @param string $error The XML-RPC error message.
+ * @param WP_User $user WP_User object.
+ */
$this->error = apply_filters( 'xmlrpc_login_error', $this->error, $user );
return false;
}
@@ -206,33 +284,28 @@ class wp_xmlrpc_server extends IXR_Server {
* @param string $password User's password.
* @return bool Whether authentication passed.
*/
- function login_pass_ok( $username, $password ) {
+ 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 );
}
}
@@ -244,7 +317,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();
@@ -272,7 +345,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 ) {
@@ -280,16 +353,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'] );
}
}
@@ -298,11 +371,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(
@@ -318,15 +393,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' => __( 'Home URL' ),
+ '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,
@@ -430,12 +515,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'
)
);
+ /**
+ * Filter the XML-RPC blog options property.
+ *
+ * @since 2.6.0
+ *
+ * @param array $blog_options An array of XML-RPC blog options.
+ */
$this->blog_options = apply_filters( 'xmlrpc_blog_options', $this->blog_options );
}
@@ -444,18 +536,20 @@ 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'
* - '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 );
@@ -470,14 +564,25 @@ 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();
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;
@@ -504,10 +609,11 @@ class wp_xmlrpc_server extends IXR_Server {
* Checks if the method received at least the minimum number of arguments.
*
* @since 3.4.0
+ * @access protected
*
* @param string|array $args Sanitize single string or array of strings.
- * @param int $count Minimum number of arguments.
- * @return boolean if $args contains at least $count arguments.
+ * @param int $count Minimum number of arguments.
+ * @return bool if `$args` contains at least $count arguments.
*/
protected function minimum_args( $args, $count ) {
if ( count( $args ) < $count ) {
@@ -523,9 +629,9 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @access protected
*
- * @param object $taxonomy The unprepared taxonomy data
- * @param array $fields The subset of taxonomy fields to return
- * @return array The prepared taxonomy data
+ * @param object $taxonomy The unprepared taxonomy data.
+ * @param array $fields The subset of taxonomy fields to return.
+ * @return array The prepared taxonomy data.
*/
protected function _prepare_taxonomy( $taxonomy, $fields ) {
$_taxonomy = array(
@@ -543,9 +649,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 );
+ /**
+ * Filter XML-RPC-prepared data for the given taxonomy.
+ *
+ * @since 3.4.0
+ *
+ * @param array $_taxonomy An array of taxonomy data.
+ * @param object $taxonomy Taxonomy object.
+ * @param array $fields The subset of taxonomy fields to return.
+ */
return apply_filters( 'xmlrpc_prepare_taxonomy', $_taxonomy, $taxonomy, $fields );
}
@@ -554,23 +672,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'] );
+ /**
+ * Filter XML-RPC-prepared data for the given term.
+ *
+ * @since 3.4.0
+ *
+ * @param array $_term An array of term data.
+ * @param array|object $term Term object or array.
+ */
return apply_filters( 'xmlrpc_prepare_term', $_term, $term );
}
@@ -579,8 +705,8 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @access protected
*
- * @param string $date
- * @return IXR_Date
+ * @param string $date Date string to convert.
+ * @return IXR_Date IXR_Date object.
*/
protected function _convert_date( $date ) {
if ( $date === '0000-00-00 00:00:00' ) {
@@ -594,9 +720,9 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @access protected
*
- * @param string $date_gmt
- * @param string $date
- * @return IXR_Date
+ * @param string $date_gmt WordPress GMT date string.
+ * @param string $date Date string.
+ * @return IXR_Date IXR_Date object.
*/
protected function _convert_date_gmt( $date_gmt, $date ) {
if ( $date !== '0000-00-00 00:00:00' && $date_gmt === '0000-00-00 00:00:00' ) {
@@ -610,15 +736,15 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @access protected
*
- * @param array $post The unprepared post data
- * @param array $fields The subset of post type fields to return
- * @return array The prepared post data
+ * @param array $post The unprepared post data.
+ * @param array $fields The subset of post type fields to return.
+ * @return array The prepared post data.
*/
protected function _prepare_post( $post, $fields ) {
- // holds the data for this post. built up based on $fields
+ // Holds the data for this post. built up based on $fields.
$_post = array( 'post_id' => strval( $post['ID'] ) );
- // prepare common post fields
+ // Prepare common post fields.
$post_fields = array(
'post_title' => $post['post_title'],
'post_date' => $this->_convert_date( $post['post_date'] ),
@@ -642,7 +768,7 @@ class wp_xmlrpc_server extends IXR_Server {
'sticky' => ( $post['post_type'] === 'post' && is_sticky( $post['ID'] ) ),
);
- // Thumbnail
+ // Thumbnail.
$post_fields['post_thumbnail'] = array();
$thumbnail_id = get_post_thumbnail_id( $post['ID'] );
if ( $thumbnail_id ) {
@@ -650,16 +776,16 @@ class wp_xmlrpc_server extends IXR_Server {
$post_fields['post_thumbnail'] = $this->_prepare_media_item( get_post( $thumbnail_id ), $thumbnail_size );
}
- // Consider future posts as published
+ // Consider future posts as published.
if ( $post_fields['post_status'] === 'future' )
$post_fields['post_status'] = 'publish';
- // Fill in blank post format
+ // Fill in blank post format.
$post_fields['post_format'] = get_post_format( $post['ID'] );
if ( empty( $post_fields['post_format'] ) )
$post_fields['post_format'] = 'standard';
- // Merge requested $post_fields fields into $_post
+ // Merge requested $post_fields fields into $_post.
if ( in_array( 'post', $fields ) ) {
$_post = array_merge( $_post, $post_fields );
} else {
@@ -692,6 +818,15 @@ class wp_xmlrpc_server extends IXR_Server {
}
}
+ /**
+ * Filter XML-RPC-prepared date for the given post.
+ *
+ * @since 3.4.0
+ *
+ * @param array $_post An array of modified post data.
+ * @param array $post An array of post data.
+ * @param array $fields An array of post fields.
+ */
return apply_filters( 'xmlrpc_prepare_post', $_post, $post, $fields );
}
@@ -700,9 +835,9 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @access protected
*
- * @param object $post_type Post type object
- * @param array $fields The subset of post fields to return
- * @return array The prepared post type data
+ * @param object $post_type Post type object.
+ * @param array $fields The subset of post fields to return.
+ * @return array The prepared post type data.
*/
protected function _prepare_post_type( $post_type, $fields ) {
$_post_type = array(
@@ -734,6 +869,14 @@ class wp_xmlrpc_server extends IXR_Server {
if ( in_array( 'taxonomies', $fields ) )
$_post_type['taxonomies'] = get_object_taxonomies( $post_type->name, 'names' );
+ /**
+ * Filter XML-RPC-prepared date for the given post type.
+ *
+ * @since 3.4.0
+ *
+ * @param array $_post_type An array of post type data.
+ * @param object $post_type Post type object.
+ */
return apply_filters( 'xmlrpc_prepare_post_type', $_post_type, $post_type );
}
@@ -742,9 +885,9 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @access protected
*
- * @param object $media_item The unprepared media item data
- * @param string $thumbnail_size The image size to use for the thumbnail URL
- * @return array The prepared media item data
+ * @param object $media_item The unprepared media item data.
+ * @param string $thumbnail_size The image size to use for the thumbnail URL.
+ * @return array The prepared media item data.
*/
protected function _prepare_media_item( $media_item, $thumbnail_size = 'thumbnail' ) {
$_media_item = array(
@@ -764,6 +907,15 @@ class wp_xmlrpc_server extends IXR_Server {
else
$_media_item['thumbnail'] = $_media_item['link'];
+ /**
+ * Filter XML-RPC-prepared data for the given media item.
+ *
+ * @since 3.4.0
+ *
+ * @param array $_media_item An array of media item data.
+ * @param object $media_item Media item object.
+ * @param string $thumbnail_size Image size.
+ */
return apply_filters( 'xmlrpc_prepare_media_item', $_media_item, $media_item, $thumbnail_size );
}
@@ -772,8 +924,8 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @access protected
*
- * @param object $page The unprepared page data
- * @return array The prepared page data
+ * @param object $page The unprepared page data.
+ * @return array The prepared page data.
*/
protected function _prepare_page( $page ) {
// Get all of the page content and link.
@@ -797,8 +949,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.
@@ -835,6 +989,14 @@ class wp_xmlrpc_server extends IXR_Server {
'wp_page_template' => $page_template
);
+ /**
+ * Filter XML-RPC-prepared data for the given page.
+ *
+ * @since 3.4.0
+ *
+ * @param array $_page An array of page data.
+ * @param WP_Post $page Page object.
+ */
return apply_filters( 'xmlrpc_prepare_page', $_page, $page );
}
@@ -843,23 +1005,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,
@@ -877,6 +1038,14 @@ class wp_xmlrpc_server extends IXR_Server {
'type' => $comment->comment_type,
);
+ /**
+ * Filter XML-RPC-prepared data for the given comment.
+ *
+ * @since 3.4.0
+ *
+ * @param array $_comment An array of prepared comment data.
+ * @param object $comment Comment object.
+ */
return apply_filters( 'xmlrpc_prepare_comment', $_comment, $comment );
}
@@ -885,9 +1054,9 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @access protected
*
- * @param WP_User $user The unprepared user object
- * @param array $fields The subset of user fields to return
- * @return array The prepared user data
+ * @param WP_User $user The unprepared user object.
+ * @param array $fields The subset of user fields to return.
+ * @return array The prepared user data.
*/
protected function _prepare_user( $user, $fields ) {
$_user = array( 'user_id' => strval( $user->ID ) );
@@ -917,6 +1086,15 @@ class wp_xmlrpc_server extends IXR_Server {
$_user = array_merge( $_user, $requested_fields );
}
+ /**
+ * Filter XML-RPC-prepared data for the given user.
+ *
+ * @since 3.5.0
+ *
+ * @param array $_user An array of user data.
+ * @param WP_User $user User object.
+ * @param array $fields An array of user fields.
+ */
return apply_filters( 'xmlrpc_prepare_user', $_user, $user, $fields );
}
@@ -925,39 +1103,54 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @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_excerpt
- * - post_content
- * - post_date_gmt | post_date
- * - post_format
- * - post_password
- * - comment_status - can be 'open' | 'closed'
- * - ping_status - can be 'open' | 'closed'
- * - sticky
- * - post_thumbnail - ID of a media item to use as the post thumbnail/featured image
- * - custom_fields - array, with each element containing 'key' and 'value'
- * - terms - array, with taxonomy names as keys and arrays of term IDs as values
- * - terms_names - array, with taxonomy names as keys and arrays of term names as values
- * - enclosure
- * - any other fields supported by wp_insert_post()
- * @return string post_id
+ * @link http://en.wikipedia.org/wiki/RSS_enclosure for information on RSS enclosures.
+ *
+ * @param array $args {
+ * Method arguments. Note: top-level arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type array $content_struct {
+ * Content struct for adding a new post. See wp_insert_post() for information on
+ * additional post fields
+ *
+ * @type string $post_type Post type. Default 'post'.
+ * @type string $post_status Post status. Default 'draft'
+ * @type string $post_title Post title.
+ * @type int $post_author Post author ID.
+ * @type string $post_excerpt Post excerpt.
+ * @type string $post_content Post content.
+ * @type string $post_date_gmt Post date in GMT.
+ * @type string $post_date Post date.
+ * @type string $post_password Post password (20-character limit).
+ * @type string $comment_status Post comment enabled status. Accepts 'open' or 'closed'.
+ * @type string $ping_status Post ping status. Accepts 'open' or 'closed'.
+ * @type bool $sticky Whether the post should be sticky. Automatically false if
+ * `$post_status` is 'private'.
+ * @type int $post_thumbnail ID of an image to use as the post thumbnail/featured image.
+ * @type array $custom_fields Array of meta key/value pairs to add to the post.
+ * @type array $terms Associative array with taxonomy names as keys and arrays
+ * of term IDs as values.
+ * @type array $terms_names Associative array with taxonomy names as keys and arrays
+ * of term names as values.
+ * @type array $enclosure {
+ * Array of feed enclosure data to add to post meta.
+ *
+ * @type string $url URL for the feed enclosure.
+ * @type int $length Size in bytes of the enclosure.
+ * @type string $type Mime-type for the enclosure.
+ * }
+ * }
+ * }
+ * @return int|IXR_Error Post ID on success, IXR_Error instance otherwise.
*/
- 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];
@@ -965,6 +1158,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'] );
@@ -984,13 +1193,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
*
- * @param WP_User $user The post author if post_author isn't set in $content_struct.
- * @param array $content_struct Post data to insert.
+ * @see wp_insert_post()
+ *
+ * @param WP_User $user The post author if post_author isn't set in $content_struct.
+ * @param array|IXR_Error $content_struct Post data to insert.
+ * @return IXR_Error|string
*/
protected function _insert_post( $user, $content_struct ) {
$defaults = array( 'post_status' => 'draft', 'post_type' => 'post', 'post_author' => 0,
@@ -1007,7 +1257,7 @@ class wp_xmlrpc_server extends IXR_Server {
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.' ) );
@@ -1057,9 +1307,9 @@ class wp_xmlrpc_server extends IXR_Server {
if ( isset( $post_data['ping_status'] ) && $post_data['ping_status'] != 'open' && $post_data['ping_status'] != 'closed' )
unset( $post_data['ping_status'] );
- // Do some timestamp voodoo
+ // Do some timestamp voodoo.
if ( ! empty( $post_data['post_date_gmt'] ) ) {
- // We know this is supposed to be GMT, so we're going to slap that Z on there by force
+ // We know this is supposed to be GMT, so we're going to slap that Z on there by force.
$dateCreated = rtrim( $post_data['post_date_gmt']->getIso(), 'Z' ) . 'Z';
} elseif ( ! empty( $post_data['post_date'] ) ) {
$dateCreated = $post_data['post_date']->getIso();
@@ -1075,25 +1325,14 @@ 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 ( ! get_post( absint( $post_data['post_thumbnail'] ) ) )
@@ -1108,14 +1347,14 @@ class wp_xmlrpc_server extends IXR_Server {
if ( isset( $post_data['terms'] ) || isset( $post_data['terms_names'] ) ) {
$post_type_taxonomies = get_object_taxonomies( $post_data['post_type'], 'objects' );
- // accumulate term IDs from terms and terms_names
+ // Accumulate term IDs from terms and terms_names.
$terms = array();
- // first validate the terms specified by ID
+ // First validate the terms specified by ID.
if ( isset( $post_data['terms'] ) && is_array( $post_data['terms'] ) ) {
$taxonomies = array_keys( $post_data['terms'] );
- // validating term ids
+ // Validating term ids.
foreach ( $taxonomies as $taxonomy ) {
if ( ! array_key_exists( $taxonomy , $post_type_taxonomies ) )
return new IXR_Error( 401, __( 'Sorry, one of the given taxonomies is not supported by the post type.' ) );
@@ -1124,6 +1363,7 @@ 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 );
@@ -1135,7 +1375,7 @@ class wp_xmlrpc_server extends IXR_Server {
}
}
- // now validate terms specified by name
+ // Now validate terms specified by name.
if ( isset( $post_data['terms_names'] ) && is_array( $post_data['terms_names'] ) ) {
$taxonomies = array_keys( $post_data['terms_names'] );
@@ -1146,15 +1386,18 @@ class wp_xmlrpc_server extends IXR_Server {
if ( ! current_user_can( $post_type_taxonomies[$taxonomy]->cap->assign_terms ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to assign a term to one of the given taxonomies.' ) );
- // for hierarchical taxonomies, we can't assign a term when multiple terms in the hierarchy share the same name
+ /*
+ * For hierarchical taxonomies, we can't assign a term when multiple terms
+ * in the hierarchy share the same name.
+ */
$ambiguous_terms = array();
if ( is_taxonomy_hierarchical( $taxonomy ) ) {
$tax_term_names = get_terms( $taxonomy, array( 'fields' => 'names', 'hide_empty' => false ) );
- // count the number of terms with the same name
+ // Count the number of terms with the same name.
$tax_term_names_count = array_count_values( $tax_term_names );
- // filter out non-ambiguous term names
+ // Filter out non-ambiguous term names.
$ambiguous_tax_term_counts = array_filter( $tax_term_names_count, array( $this, '_is_greater_than_one') );
$ambiguous_terms = array_keys( $ambiguous_tax_term_counts );
@@ -1168,11 +1411,11 @@ class wp_xmlrpc_server extends IXR_Server {
$term = get_term_by( 'name', $term_name, $taxonomy );
if ( ! $term ) {
- // term doesn't exist, so check that the user is allowed to create new terms
+ // Term doesn't exist, so check that the user is allowed to create new terms.
if ( ! current_user_can( $post_type_taxonomies[$taxonomy]->cap->edit_terms ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to add a term to one of the given taxonomies.' ) );
- // create the new term
+ // Create the new term.
$term_info = wp_insert_term( $term_name, $taxonomy );
if ( is_wp_error( $term_info ) )
return new IXR_Error( 500, $term_info->get_error_message() );
@@ -1188,7 +1431,7 @@ class wp_xmlrpc_server extends IXR_Server {
$post_data['tax_input'] = $terms;
unset( $post_data['terms'], $post_data['terms_names'] );
} else {
- // do not allow direct submission of 'tax_input', clients must use 'terms' and/or 'terms_names'
+ // Do not allow direct submission of 'tax_input', clients must use 'terms' and/or 'terms_names'.
unset( $post_data['tax_input'], $post_data['post_category'], $post_data['tags_input'] );
}
@@ -1201,12 +1444,20 @@ class wp_xmlrpc_server extends IXR_Server {
unset( $post_data['post_format'] );
}
- // Handle enclosures
+ // Handle enclosures.
$enclosure = isset( $post_data['enclosure'] ) ? $post_data['enclosure'] : null;
$this->add_enclosure_if_new( $post_ID, $enclosure );
$this->attach_uploads( $post_ID, $post_data['post_content'] );
+ /**
+ * Filter post data array to be inserted via XML-RPC.
+ *
+ * @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 = $update ? wp_update_post( $post_data, true ) : wp_insert_post( $post_data, true );
@@ -1227,21 +1478,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];
@@ -1250,6 +1503,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 );
@@ -1264,11 +1518,13 @@ class wp_xmlrpc_server extends IXR_Server {
}
}
- // convert the date field back to IXR form
+ // Convert the date field back to IXR form.
$post['post_date'] = $this->_convert_date( $post['post_date'] );
- // ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct,
- // since _insert_post will ignore the non-GMT date if the GMT date is set
+ /*
+ * Ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct,
+ * since _insert_post() will ignore the non-GMT date if the GMT date is set.
+ */
if ( $post['post_date_gmt'] == '0000-00-00 00:00:00' || isset( $content_struct['post_date'] ) )
unset( $post['post_date_gmt'] );
else
@@ -1289,21 +1545,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];
@@ -1311,14 +1570,14 @@ 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 = 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 );
@@ -1343,13 +1602,18 @@ class wp_xmlrpc_server extends IXR_Server {
* groups are 'post' (all basic fields), 'taxonomies', 'custom_fields',
* and 'enclosure'.
*
- * @uses get_post()
- * @param array $args Method parameters. Contains:
- * - int $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'
@@ -1373,25 +1637,34 @@ 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 {
+ /**
+ * Filter the list of post query fields used by the given XML-RPC method.
+ *
+ * @since 3.4.0
+ *
+ * @param array $fields Array of post fields. 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 = get_post( $post_id, ARRAY_A );
@@ -1399,8 +1672,7 @@ class wp_xmlrpc_server extends IXR_Server {
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_post, $post_id ) )
+ if ( ! current_user_can( 'edit_post', $post_id ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
return $this->_prepare_post( $post, $fields );
@@ -1411,44 +1683,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', 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();
@@ -1491,12 +1763,11 @@ class wp_xmlrpc_server extends IXR_Server {
if ( ! $posts_list )
return array();
- // holds all the posts data
+ // Holds all the posts data.
$struct = array();
foreach ( $posts_list as $post ) {
- $post_type = get_post_type_object( $post['post_type'] );
- if ( ! current_user_can( $post_type->cap->edit_post, $post['ID'] ) )
+ if ( ! current_user_can( 'edit_post', $post['ID'] ) )
continue;
$struct[] = $this->_prepare_post( $post, $fields );
@@ -1510,35 +1781,34 @@ 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'] ) )
@@ -1596,37 +1866,36 @@ 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'] ) )
@@ -1695,22 +1964,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];
@@ -1719,6 +1991,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.deleteTerm' );
if ( ! taxonomy_exists( $taxonomy ) )
@@ -1753,14 +2026,18 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 3.4.0
*
- * @uses get_term()
- * @param array $args Method parameters. Contains:
- * - int $blog_id
- * - 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'
@@ -1771,13 +2048,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];
@@ -1786,6 +2062,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.getTerm' );
if ( ! taxonomy_exists( $taxonomy ) )
@@ -1815,22 +2092,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];
@@ -1839,6 +2120,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.getTerms' );
if ( ! taxonomy_exists( $taxonomy ) )
@@ -1891,33 +2173,49 @@ 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 {
+ /**
+ * Filter the taxonomy query fields used by the given XML-RPC method.
+ *
+ * @since 3.4.0
+ *
+ * @param array $fields An array of taxonomy fields to retrieve.
+ * @param string $method The method name.
+ */
$fields = apply_filters( 'xmlrpc_default_taxonomy_fields', array( 'labels', 'cap', 'object_type' ), 'wp.getTaxonomy' );
+ }
if ( ! $user = $this->login( $username, $password ) )
return $this->error;
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getTaxonomy' );
if ( ! taxonomy_exists( $taxonomy ) )
@@ -1936,32 +2234,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' );
@@ -1992,13 +2299,17 @@ class wp_xmlrpc_server extends IXR_Server {
* groups are 'basic' and 'all'.
*
* @uses get_userdata()
- * @param array $args Method parameters. Contains:
- * - int $blog_id
- * - string $username
- * - string $password
- * - int $user_id
- * - array $fields optional
- * @return array contains (based on $fields parameter):
+ *
+ * @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'
@@ -2012,25 +2323,34 @@ class wp_xmlrpc_server extends IXR_Server {
* - 'display_name'
* - 'roles'
*/
- function wp_getUser( $args ) {
+ public function wp_getUser( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
return $this->error;
$this->escape( $args );
- $blog_id = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
- $user_id = (int) $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $user_id = (int) $args[3];
- if ( isset( $args[4] ) )
+ if ( isset( $args[4] ) ) {
$fields = $args[4];
- else
+ } else {
+ /**
+ * Filter the default user query fields used by the given XML-RPC method.
+ *
+ * @since 3.5.0
+ *
+ * @param array $fields User query fields for given method. Default 'all'.
+ * @param string $method The method name.
+ */
$fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUser' );
+ }
if ( ! $user = $this->login( $username, $password ) )
return $this->error;
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getUser' );
if ( ! current_user_can( 'edit_user', $user_id ) )
@@ -2039,7 +2359,7 @@ class wp_xmlrpc_server extends IXR_Server {
$user_data = get_userdata( $user_id );
if ( ! $user_data )
- return new IXR_Error( 404, __( 'Invalid user ID' ) );
+ return new IXR_Error( 404, __( 'Invalid user ID.' ) );
return $this->_prepare_user( $user_data, $fields );
}
@@ -2057,33 +2377,38 @@ class wp_xmlrpc_server extends IXR_Server {
* @uses get_users()
* @see wp_getUser() for more on $fields and return values
*
- * @param array $args Method parameters. Contains:
- * - int $blog_id
- * - string $username
- * - string $password
- * - array $filter optional
- * - array $fields optional
- * @return array users data
+ * @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_getUsers( $args ) {
+ public function wp_getUsers( $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_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' ) )
@@ -2126,31 +2451,37 @@ class wp_xmlrpc_server extends IXR_Server {
* Retrieve information about the requesting user.
*
* @uses get_userdata()
- * @param array $args Method parameters. Contains:
- * - int $blog_id
- * - string $username
- * - string $password
- * - array $fields optional
- * @return array (@see wp_getUser)
+ *
+ * @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)
*/
- function wp_getProfile( $args ) {
+ public function wp_getProfile( $args ) {
if ( ! $this->minimum_args( $args, 3 ) )
return $this->error;
$this->escape( $args );
- $blog_id = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
- if ( isset( $args[3] ) )
+ if ( isset( $args[3] ) ) {
$fields = $args[3];
- else
+ } else {
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
$fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getProfile' );
+ }
if ( ! $user = $this->login( $username, $password ) )
return $this->error;
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getProfile' );
if ( ! current_user_can( 'edit_user', $user->ID ) )
@@ -2165,12 +2496,14 @@ class wp_xmlrpc_server extends IXR_Server {
* Edit user's profile.
*
* @uses wp_update_user()
- * @param array $args Method parameters. Contains:
- * - int $blog_id
- * - string $username
- * - string $password
- * - array $content_struct
- * It can optionally contain:
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $content_struct It can optionally contain:
* - 'first_name'
* - 'last_name'
* - 'website'
@@ -2178,15 +2511,15 @@ class wp_xmlrpc_server extends IXR_Server {
* - 'nickname'
* - 'nicename'
* - 'bio'
- * @return bool True, on success.
+ * }
+ * @return true|IXR_Error True, on success.
*/
- function wp_editProfile( $args ) {
+ public function wp_editProfile( $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];
@@ -2194,6 +2527,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.editProfile' );
if ( ! current_user_can( 'edit_user', $user->ID ) )
@@ -2241,20 +2575,22 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 2.2.0
*
- * @param array $args Method parameters. Contains:
- * - blog_id
- * - page_id
- * - username
- * - password
- * @return array
+ * @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
*/
- function wp_getPage($args) {
- $this->escape($args);
+ public function wp_getPage( $args ) {
+ $this->escape( $args );
- $blog_id = (int) $args[0];
- $page_id = (int) $args[1];
- $username = $args[2];
- $password = $args[3];
+ $page_id = (int) $args[1];
+ $username = $args[2];
+ $password = $args[3];
if ( !$user = $this->login($username, $password) ) {
return $this->error;
@@ -2267,7 +2603,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_page', $page_id ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit this page.' ) );
- do_action('xmlrpc_call', 'wp.getPage');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getPage' );
// If we found the page then format the data.
if ( $page->ID && ($page->post_type == 'page') ) {
@@ -2275,7 +2612,7 @@ class wp_xmlrpc_server extends IXR_Server {
}
// If the page doesn't exist indicate that.
else {
- return(new IXR_Error(404, __('Sorry, no such page.')));
+ return new IXR_Error( 404, __( 'Sorry, no such page.' ) );
}
}
@@ -2284,20 +2621,22 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 2.2.0
*
- * @param array $args Method parameters. Contains:
- * - blog_id
- * - username
- * - password
- * - num_pages
- * @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 $num_pages
+ * }
+ * @return array|IXR_Error
*/
- function wp_getPages($args) {
- $this->escape($args);
+ public function wp_getPages( $args ) {
+ $this->escape( $args );
- $blog_id = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
- $num_pages = isset($args[3]) ? (int) $args[3] : 10;
+ $username = $args[1];
+ $password = $args[2];
+ $num_pages = isset($args[3]) ? (int) $args[3] : 10;
if ( !$user = $this->login($username, $password) )
return $this->error;
@@ -2305,7 +2644,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_pages' ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit pages.' ) );
- do_action('xmlrpc_call', 'wp.getPages');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getPages' );
$pages = get_posts( array('post_type' => 'page', 'post_status' => 'any', 'numberposts' => $num_pages) );
$num_pages = count($pages);
@@ -2319,12 +2659,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();
}
/**
@@ -2332,26 +2670,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 );
}
/**
@@ -2359,40 +2705,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 = 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 do not have the right 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;
}
/**
@@ -2400,31 +2761,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 = 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 do not have the right to edit this page.' ) );
// Mark this as content for a page.
$content['post_type'] = 'page';
@@ -2439,7 +2813,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 );
}
/**
@@ -2447,17 +2821,24 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 2.2.0
*
- * @param array $args Method parameters.
- * @return unknown
+ * @global wpdb $wpdb
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
+ * @return array|IXR_Error
*/
- 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;
@@ -2465,7 +2846,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_pages' ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit pages.' ) );
- do_action('xmlrpc_call', 'wp.getPageList');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getPageList' );
// Get list of pages ids and titles
$page_list = $wpdb->get_results("
@@ -2491,7 +2873,7 @@ class wp_xmlrpc_server extends IXR_Server {
unset($page_list[$i]->post_status);
}
- return($page_list);
+ return $page_list;
}
/**
@@ -2499,24 +2881,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 cannot edit posts on this site.' ) );
- do_action('xmlrpc_call', 'wp.getAuthors');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getAuthors' );
$authors = array();
foreach ( get_users( array( 'fields' => array('ID','user_login','display_name') ) ) as $user ) {
@@ -2535,15 +2922,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;
@@ -2551,12 +2943,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 ) {
+ $struct = array();
$struct['tag_id'] = $tag->term_id;
$struct['name'] = $tag->name;
$struct['count'] = $tag->count;
@@ -2576,25 +2970,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 do not have the right to add a category.'));
// If no slug was provided make it empty so that
// WordPress will generate one.
@@ -2622,11 +3023,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;
@@ -2637,29 +3046,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 {@link 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.' ) );
$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;
}
@@ -2669,25 +3094,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);
@@ -2698,7 +3131,7 @@ class wp_xmlrpc_server extends IXR_Server {
);
}
- return($category_suggestions);
+ return $category_suggestions;
}
/**
@@ -2706,13 +3139,19 @@ 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];
@@ -2723,7 +3162,8 @@ class wp_xmlrpc_server extends IXR_Server {
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) )
return new IXR_Error( 404, __( 'Invalid comment ID.' ) );
@@ -2734,7 +3174,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'.
@@ -2747,16 +3187,22 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @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 {@link 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) )
return $this->error;
@@ -2764,7 +3210,8 @@ class wp_xmlrpc_server extends IXR_Server {
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']) )
$status = $struct['status'];
@@ -2783,12 +3230,13 @@ class wp_xmlrpc_server extends IXR_Server {
if ( isset($struct['number']) )
$number = absint($struct['number']);
- $comments = get_comments( array('status' => $status, 'post_id' => $post_id, 'offset' => $offset, 'number' => $number ) );
+ $comments = get_comments( array( 'status' => $status, 'post_id' => $post_id, 'offset' => $offset, 'number' => $number ) );
$comments_struct = array();
-
- foreach ( $comments as $comment ) {
- $comments_struct[] = $this->_prepare_comment( $comment );
+ if ( is_array( $comments ) ) {
+ foreach ( $comments as $comment ) {
+ $comments_struct[] = $this->_prepare_comment( $comment );
+ }
}
return $comments_struct;
@@ -2803,17 +3251,19 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @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 {@link 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];
@@ -2830,12 +3280,22 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_comment', $comment_ID ) )
return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) );
- do_action('xmlrpc_call', 'wp.deleteComment');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.deleteComment' );
$status = wp_delete_comment( $comment_ID );
- if( true == $status )
+ if ( $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;
}
@@ -2843,7 +3303,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:
@@ -2852,22 +3312,24 @@ 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];
@@ -2885,7 +3347,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_comment', $comment_ID ) )
return new IXR_Error( 403, __( 'You are not allowed to moderate comments on this site.' ) );
- do_action('xmlrpc_call', 'wp.editComment');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.editComment' );
if ( isset($content_struct['status']) ) {
$statuses = get_comment_statuses();
@@ -2926,6 +3389,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;
@@ -2936,30 +3407,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 {@link 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);
+ /**
+ * Filter whether to allow anonymous comments over XML-RPC.
+ *
+ * @since 2.7.0
+ *
+ * @param bool $allow Whether to allow anonymous commenting via XML-RPC.
+ * Default false.
+ */
+ $allow_anon = apply_filters( 'xmlrpc_allow_anonymous_comments', false );
$user = $this->login($username, $password);
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;
}
@@ -2975,12 +3460,13 @@ class wp_xmlrpc_server extends IXR_Server {
if ( ! get_post($post_id) )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
+ $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 );
+ $comment['comment_author'] = $this->escape( $user->display_name );
+ $comment['comment_author_email'] = $this->escape( $user->user_email );
+ $comment['comment_author_url'] = $this->escape( $user->user_url );
$comment['user_ID'] = $user->ID;
} else {
$comment['comment_author'] = '';
@@ -3009,10 +3495,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;
@@ -3023,15 +3518,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_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) )
return $this->error;
@@ -3039,7 +3539,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'moderate_comments' ) )
return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) );
- do_action('xmlrpc_call', 'wp.getCommentStatusList');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getCommentStatusList' );
return get_comment_statuses();
}
@@ -3049,13 +3550,19 @@ 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];
@@ -3066,7 +3573,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_posts' ) )
return new IXR_Error( 403, __( 'You are not allowed access to details about comments.' ) );
- do_action('xmlrpc_call', 'wp.getCommentCount');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getCommentCount' );
$count = wp_count_comments( $post_id );
return array(
@@ -3082,15 +3590,20 @@ 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;
@@ -3098,7 +3611,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_posts' ) )
return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) );
- do_action('xmlrpc_call', 'wp.getPostStatusList');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getPostStatusList' );
return get_post_statuses();
}
@@ -3108,15 +3622,20 @@ 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;
@@ -3124,7 +3643,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_pages' ) )
return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) );
- do_action('xmlrpc_call', 'wp.getPageStatusList');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getPageStatusList' );
return get_page_statuses();
}
@@ -3134,15 +3654,20 @@ 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;
@@ -3161,13 +3686,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();
@@ -3190,8 +3721,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];
@@ -3200,6 +3732,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;
}
}
@@ -3211,13 +3746,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];
@@ -3228,6 +3769,7 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'manage_options' ) )
return new IXR_Error( 403, __( '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 ) )
@@ -3236,7 +3778,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
@@ -3248,12 +3790,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'
@@ -3263,10 +3808,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];
@@ -3277,7 +3821,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'upload_files' ) )
return new IXR_Error( 403, __( 'You do not have permission to upload files.' ) );
- do_action('xmlrpc_call', 'wp.getMediaItem');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getMediaItem' );
if ( ! $attachment = get_post($attachment_id) )
return new IXR_Error( 404, __( 'Invalid attachment ID.' ) );
@@ -3288,30 +3833,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() ;
@@ -3322,7 +3869,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'upload_files' ) )
return new IXR_Error( 401, __( 'You do not have permission to upload files.' ) );
- do_action('xmlrpc_call', 'wp.getMediaLibrary');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getMediaLibrary' );
$parent_id = ( isset($struct['parent_id']) ) ? absint($struct['parent_id']) : '' ;
$mime_type = ( isset($struct['mime_type']) ) ? $struct['mime_type'] : '' ;
@@ -3340,20 +3888,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];
@@ -3363,16 +3913,18 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_posts' ) )
return new IXR_Error( 403, __( 'You are not allowed access to details about this site.' ) );
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getPostFormats' );
$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];
@@ -3389,14 +3941,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'
@@ -3407,33 +3963,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 {
+ /**
+ * Filter the default query fields used by the given XML-RPC method.
+ *
+ * @since 3.4.0
+ *
+ * @param array $fields An array of post type query fields for the given method.
+ * @param string $method The method name.
+ */
$fields = apply_filters( 'xmlrpc_default_posttype_fields', array( 'labels', 'cap', 'taxonomies' ), 'wp.getPostType' );
+ }
if ( !$user = $this->login( $username, $password ) )
return $this->error;
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getPostType' );
- if( ! post_type_exists( $post_type_name ) )
+ if ( ! post_type_exists( $post_type_name ) )
return new IXR_Error( 403, __( 'Invalid post type' ) );
$post_type = get_post_type_object( $post_type_name );
- if( ! current_user_can( $post_type->cap->edit_posts ) )
+ if ( ! current_user_can( $post_type->cap->edit_posts ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post type.' ) );
return $this->_prepare_post_type( $post_type, $fields );
@@ -3444,34 +4009,40 @@ 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' );
@@ -3479,7 +4050,7 @@ class wp_xmlrpc_server extends IXR_Server {
$struct = array();
foreach( $post_types as $post_type ) {
- if( ! current_user_can( $post_type->cap->edit_posts ) )
+ if ( ! current_user_can( $post_type->cap->edit_posts ) )
continue;
$struct[$post_type->name] = $this->_prepare_post_type( $post_type, $fields );
@@ -3499,43 +4070,55 @@ class wp_xmlrpc_server extends IXR_Server {
* @uses wp_get_post_revisions()
* @see wp_getPost() for more on $fields
*
- * @param array $args Method parameters. Contains:
- * - int $blog_id
- * - string $username
- * - string $password
- * - int $post_id
- * - array $fields
- * @return array contains a collection of posts.
+ * @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.
*/
- function wp_getRevisions( $args ) {
+ public function wp_getRevisions( $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 {
+ /**
+ * Filter the default revision query fields used by the given XML-RPC method.
+ *
+ * @since 3.5.0
+ *
+ * @param array $field An array of revision query fields.
+ * @param string $method The method name.
+ */
$fields = apply_filters( 'xmlrpc_default_revision_fields', array( 'post_date', 'post_date_gmt' ), 'wp.getRevisions' );
+ }
if ( ! $user = $this->login( $username, $password ) )
return $this->error;
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getRevisions' );
if ( ! $post = get_post( $post_id ) )
- return new IXR_Error( 404, __( 'Invalid post ID' ) );
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( ! current_user_can( 'edit_post', $post_id ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts.' ) );
// Check if revisions are enabled.
- if ( ! WP_POST_REVISIONS || ! post_type_supports( $post->post_type, 'revisions' ) )
+ if ( ! wp_revisions_enabled( $post ) )
return new IXR_Error( 401, __( 'Sorry, revisions are disabled.' ) );
$revisions = wp_get_post_revisions( $post_id );
@@ -3566,20 +4149,22 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @uses wp_restore_post_revision()
*
- * @param array $args Method parameters. Contains:
- * - int $blog_id
- * - string $username
- * - string $password
- * - int $post_id
- * @return bool false if there was an error restoring, 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 $revision_id
+ * }
+ * @return bool|IXR_Error false if there was an error restoring, true if success.
*/
- function wp_restoreRevision( $args ) {
+ public function wp_restoreRevision( $args ) {
if ( ! $this->minimum_args( $args, 3 ) )
return $this->error;
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$revision_id = (int) $args[3];
@@ -3587,22 +4172,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.restoreRevision' );
if ( ! $revision = wp_get_post_revision( $revision_id ) )
- return new IXR_Error( 404, __( 'Invalid post ID' ) );
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( wp_is_post_autosave( $revision ) )
- return new IXR_Error( 404, __( 'Invalid post ID' ) );
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( ! $post = get_post( $revision->post_parent ) )
- return new IXR_Error( 404, __( 'Invalid post ID' ) );
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( ! current_user_can( 'edit_post', $revision->post_parent ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
// Check if revisions are disabled.
- if ( ! WP_POST_REVISIONS || ! post_type_supports( $post->post_type, 'revisions' ) )
+ if ( ! wp_revisions_enabled( $post ) )
return new IXR_Error( 401, __( 'Sorry, revisions are disabled.' ) );
$post = wp_restore_post_revision( $revision_id );
@@ -3621,22 +4207,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');
@@ -3655,8 +4248,10 @@ class wp_xmlrpc_server extends IXR_Server {
* Private function for retrieving a users blogs for multisite setups
*
* @access protected
+ *
+ * @return array|IXR_Error
*/
- function _multisite_getUsersBlogs($args) {
+ protected function _multisite_getUsersBlogs($args) {
$current_blog = get_blog_details();
$domain = $current_blog->domain;
@@ -3687,15 +4282,20 @@ 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;
@@ -3703,7 +4303,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_posts' ) )
return new IXR_Error( 401, __( 'Sorry, you do not have access to user data on this site.' ) );
- do_action('xmlrpc_call', 'blogger.getUserInfo');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'blogger.getUserInfo' );
$struct = array(
'nickname' => $user->nickname,
@@ -3721,16 +4322,22 @@ 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;
@@ -3742,13 +4349,14 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_post', $post_ID ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
- do_action('xmlrpc_call', 'blogger.getPost');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'blogger.getPost' );
$categories = implode(',', wp_get_post_categories($post_ID));
- $content = ''.stripslashes($post_data['post_title']).'';
+ $content = ''.wp_unslash($post_data['post_title']).'';
$content .= ''.$categories.'';
- $content .= stripslashes($post_data['post_content']);
+ $content .= wp_unslash($post_data['post_content']);
$struct = array(
'userid' => $post_data['post_author'],
@@ -3765,17 +4373,24 @@ 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 string $appkey (unused)
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $numberposts (optional)
+ * }
+ * @return array|IXR_Error
*/
- function blogger_getRecentPosts($args) {
+ public function blogger_getRecentPosts( $args ) {
$this->escape($args);
// $args[0] = appkey - ignored
- $blog_ID = (int) $args[1]; /* though we don't use it yet */
$username = $args[2];
- $password = $args[3];
+ $password = $args[3];
if ( isset( $args[4] ) )
$query = array( 'numberposts' => absint( $args[4] ) );
else
@@ -3784,7 +4399,11 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'blogger.getRecentPosts');
+ if ( ! current_user_can( 'edit_posts' ) )
+ return new IXR_Error( 401, __( 'Sorry, you cannot edit posts on this site.' ) );
+
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'blogger.getRecentPosts' );
$posts_list = wp_get_recent_posts( $query );
@@ -3793,6 +4412,7 @@ class wp_xmlrpc_server extends IXR_Server {
return $this->error;
}
+ $recent_posts = array();
foreach ($posts_list as $entry) {
if ( !current_user_can( 'edit_post', $entry['ID'] ) )
continue;
@@ -3800,22 +4420,16 @@ class wp_xmlrpc_server extends IXR_Server {
$post_date = $this->_convert_date( $entry['post_date'] );
$categories = implode(',', wp_get_post_categories($entry['ID']));
- $content = ''.stripslashes($entry['post_title']).'';
+ $content = ''.wp_unslash($entry['post_title']).'';
$content .= ''.$categories.'';
- $content .= stripslashes($entry['post_content']);
+ $content .= wp_unslash($entry['post_content']);
- $struct[] = array(
+ $recent_posts[] = array(
'userid' => $entry['post_author'],
'dateCreated' => $post_date,
'content' => $content,
'postid' => (string) $entry['ID'],
);
-
- }
-
- $recent_posts = array();
- for ( $j=0; $jescape($args);
+ public function blogger_newPost( $args ) {
+ $this->escape( $args );
- $blog_ID = (int) $args[1]; /* though we don't use it yet */
$username = $args[2];
- $password = $args[3];
- $content = $args[4];
- $publish = $args[5];
+ $password = $args[3];
+ $content = $args[4];
+ $publish = $args[5];
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'blogger.newPost');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'blogger.newPost' );
$cap = ($publish) ? 'publish_posts' : 'edit_posts';
if ( ! current_user_can( get_post_type_object( 'post' )->cap->create_posts ) || !current_user_can($cap) )
@@ -3879,7 +4503,7 @@ class wp_xmlrpc_server extends IXR_Server {
$post_date = current_time('mysql');
$post_date_gmt = current_time('mysql', 1);
- $post_data = compact('blog_ID', 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_title', 'post_category', 'post_status');
+ $post_data = compact('post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_title', 'post_category', 'post_status');
$post_ID = wp_insert_post($post_data);
if ( is_wp_error( $post_ID ) )
@@ -3890,6 +4514,14 @@ class wp_xmlrpc_server extends IXR_Server {
$this->attach_uploads( $post_ID, $post_content );
+ /**
+ * Fires after a new post has been successfully created via the XML-RPC Blogger API.
+ *
+ * @since 3.4.0
+ *
+ * @param int $post_ID ID of the new post.
+ * @param array $args An array of new post arguments.
+ */
do_action( 'xmlrpc_call_success_blogger_newPost', $post_ID, $args );
return $post_ID;
@@ -3900,52 +4532,71 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return bool true when done.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * @type string $content
+ * }
+ * @return true|IXR_Error true when done.
*/
- function blogger_editPost($args) {
+ public function blogger_editPost( $args ) {
$this->escape($args);
- $post_ID = (int) $args[1];
- $username = $args[2];
- $password = $args[3];
- $content = $args[4];
- $publish = $args[5];
+ $post_ID = (int) $args[1];
+ $username = $args[2];
+ $password = $args[3];
+ $content = $args[4];
- if ( !$user = $this->login($username, $password) )
+ if ( ! $user = $this->login( $username, $password ) ) {
return $this->error;
+ }
- do_action('xmlrpc_call', 'blogger.editPost');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'blogger.editPost' );
- $actual_post = get_post($post_ID,ARRAY_A);
+ $actual_post = get_post( $post_ID, ARRAY_A );
- if ( !$actual_post || $actual_post['post_type'] != 'post' )
- return new IXR_Error(404, __('Sorry, no such post.'));
+ if ( ! $actual_post || $actual_post['post_type'] != 'post' ) {
+ return new IXR_Error( 404, __( 'Sorry, no such post.' ) );
+ }
$this->escape($actual_post);
- if ( !current_user_can('edit_post', $post_ID) )
+ if ( ! current_user_can( 'edit_post', $post_ID ) ) {
return new IXR_Error(401, __('Sorry, you do not have the right to edit this post.'));
+ }
+ if ( 'publish' == $actual_post['post_status'] && ! current_user_can( 'publish_posts' ) ) {
+ return new IXR_Error( 401, __( 'Sorry, you do not have the right to publish this post.' ) );
+ }
- extract($actual_post, EXTR_SKIP);
-
- if ( ('publish' == $post_status) && !current_user_can('publish_posts') )
- return new IXR_Error(401, __('Sorry, you do not have the right to publish this post.'));
-
- $post_title = xmlrpc_getposttitle($content);
- $post_category = xmlrpc_getpostcategory($content);
- $post_content = xmlrpc_removepostdata($content);
-
- $postdata = compact('ID', 'post_content', 'post_title', 'post_category', 'post_status', 'post_excerpt');
+ $postdata = array();
+ $postdata['ID'] = $actual_post['ID'];
+ $postdata['post_content'] = xmlrpc_removepostdata( $content );
+ $postdata['post_title'] = xmlrpc_getposttitle( $content );
+ $postdata['post_category'] = xmlrpc_getpostcategory( $content );
+ $postdata['post_status'] = $actual_post['post_status'];
+ $postdata['post_excerpt'] = $actual_post['post_excerpt'];
- $result = wp_update_post($postdata);
+ $result = wp_update_post( $postdata );
- if ( !$result )
+ if ( ! $result ) {
return new IXR_Error(500, __('For some strange yet very annoying reason, this post could not be edited.'));
-
- $this->attach_uploads( $ID, $post_content );
-
+ }
+ $this->attach_uploads( $actual_post['ID'], $postdata['post_content'] );
+
+ /**
+ * Fires after a post has been successfully updated via the XML-RPC Blogger API.
+ *
+ * @since 3.4.0
+ *
+ * @param int $post_ID ID of the updated post.
+ * @param array $args An array of arguments for the post to edit.
+ */
do_action( 'xmlrpc_call_success_blogger_editPost', $post_ID, $args );
return true;
@@ -3956,21 +4607,28 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return bool True when post is deleted.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * }
+ * @return true|IXR_Error True when post is deleted.
*/
- function blogger_deletePost($args) {
- $this->escape($args);
+ public function blogger_deletePost( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[1];
- $username = $args[2];
- $password = $args[3];
- $publish = $args[4];
+ $post_ID = (int) $args[1];
+ $username = $args[2];
+ $password = $args[3];
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'blogger.deletePost');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'blogger.deletePost' );
$actual_post = get_post($post_ID,ARRAY_A);
@@ -3985,6 +4643,14 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !$result )
return new IXR_Error(500, __('For some strange yet very annoying reason, this post could not be deleted.'));
+ /**
+ * Fires after a post has been successfully deleted via the XML-RPC Blogger API.
+ *
+ * @since 3.4.0
+ *
+ * @param int $post_ID ID of the deleted post.
+ * @param array $args An array of arguments to delete the post.
+ */
do_action( 'xmlrpc_call_success_blogger_deletePost', $post_ID, $args );
return true;
@@ -4021,27 +4687,30 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters. Contains:
- * - blog_id
- * - username
- * - password
- * - content_struct
- * - publish
- * @return int
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $content_struct
+ * @type int $publish
+ * }
+ * @return int|IXR_Error
*/
- function mw_newPost($args) {
+ public function mw_newPost($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
$content_struct = $args[3];
- $publish = isset( $args[4] ) ? $args[4] : 0;
+ $publish = isset( $args[4] ) ? $args[4] : 0;
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'metaWeblog.newPost');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'metaWeblog.newPost' );
$page_template = '';
if ( !empty( $content_struct['post_type'] ) ) {
@@ -4118,15 +4787,14 @@ class wp_xmlrpc_server extends IXR_Server {
switch ( $post_type ) {
case "post":
if ( !current_user_can( 'edit_others_posts' ) )
- return( new IXR_Error( 401, __( 'You are not allowed to create posts as this user.' ) ) );
+ return new IXR_Error( 401, __( 'You are not allowed to create posts as this user.' ) );
break;
case "page":
if ( !current_user_can( 'edit_others_pages' ) )
- return( new IXR_Error( 401, __( 'You are not allowed to create pages as this user.' ) ) );
+ return new IXR_Error( 401, __( 'You are not allowed to create pages as this user.' ) );
break;
default:
- return( new IXR_Error( 401, __( 'Invalid post type' ) ) );
- break;
+ return new IXR_Error( 401, __( 'Invalid post type' ) );
}
$author = get_userdata( $content_struct['wp_author_id'] );
if ( ! $author )
@@ -4168,7 +4836,7 @@ class wp_xmlrpc_server extends IXR_Server {
$comment_status = 'open';
break;
default:
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
break;
}
} else {
@@ -4181,12 +4849,12 @@ class wp_xmlrpc_server extends IXR_Server {
$comment_status = 'open';
break;
default:
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
break;
}
}
} else {
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
}
if ( isset($content_struct['mt_allow_pings']) ) {
@@ -4199,7 +4867,7 @@ class wp_xmlrpc_server extends IXR_Server {
$ping_status = 'open';
break;
default:
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
break;
}
} else {
@@ -4211,12 +4879,12 @@ class wp_xmlrpc_server extends IXR_Server {
$ping_status = 'open';
break;
default:
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
break;
}
}
} else {
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
}
if ( $post_more )
@@ -4261,10 +4929,12 @@ class wp_xmlrpc_server extends IXR_Server {
// Only posts can be sticky
if ( $post_type == 'post' && isset( $content_struct['sticky'] ) ) {
- if ( $content_struct['sticky'] == true )
- stick_post( $post_ID );
- elseif ( $content_struct['sticky'] == false )
- unstick_post( $post_ID );
+ $data = $postdata;
+ $data['sticky'] = $content_struct['sticky'];
+ $error = $this->_toggle_sticky( $data );
+ if ( $error ) {
+ return $error;
+ }
}
if ( isset($content_struct['custom_fields']) )
@@ -4295,27 +4965,37 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !$post_ID )
return new IXR_Error(500, __('Sorry, your entry could not be posted. Something wrong happened.'));
+ /**
+ * Fires after a new post has been successfully created via the XML-RPC MovableType API.
+ *
+ * @since 3.4.0
+ *
+ * @param int $post_ID ID of the new post.
+ * @param array $args An array of arguments to create the new post.
+ */
do_action( 'xmlrpc_call_success_mw_newPost', $post_ID, $args );
return strval($post_ID);
}
- function add_enclosure_if_new($post_ID, $enclosure) {
+ /**
+ * @param integer $post_ID
+ * @param array $enclosure
+ */
+ public function add_enclosure_if_new( $post_ID, $enclosure ) {
if ( is_array( $enclosure ) && isset( $enclosure['url'] ) && isset( $enclosure['length'] ) && isset( $enclosure['type'] ) ) {
-
- $encstring = $enclosure['url'] . "\n" . $enclosure['length'] . "\n" . $enclosure['type'];
+ $encstring = $enclosure['url'] . "\n" . $enclosure['length'] . "\n" . $enclosure['type'] . "\n";
$found = false;
- foreach ( (array) get_post_custom($post_ID) as $key => $val) {
- if ($key == 'enclosure') {
- foreach ( (array) $val as $enc ) {
- if ($enc == $encstring) {
- $found = true;
- break 2;
- }
+ if ( $enclosures = get_post_meta( $post_ID, 'enclosure' ) ) {
+ foreach ( $enclosures as $enc ) {
+ // This method used to omit the trailing new line. #23219
+ if ( rtrim( $enc, "\n" ) == rtrim( $encstring, "\n" ) ) {
+ $found = true;
+ break;
}
}
}
- if (!$found)
+ if ( ! $found )
add_post_meta( $post_ID, 'enclosure', $encstring );
}
}
@@ -4325,17 +5005,19 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 2.1.0
*
+ * @global wpdb $wpdb
+ *
* @param int $post_ID Post ID.
* @param string $post_content Post Content for attachment.
*/
- function attach_uploads( $post_ID, $post_content ) {
+ public function attach_uploads( $post_ID, $post_content ) {
global $wpdb;
// find any unattached files
$attachments = $wpdb->get_results( "SELECT ID, guid FROM {$wpdb->posts} WHERE post_parent = '0' AND post_type = 'attachment'" );
if ( is_array( $attachments ) ) {
foreach ( $attachments as $file ) {
- if ( strpos( $post_content, $file->guid ) !== false )
+ if ( ! empty( $file->guid ) && strpos( $post_content, $file->guid ) !== false )
$wpdb->update($wpdb->posts, array('post_parent' => $post_ID), array('ID' => $file->ID) );
}
}
@@ -4346,12 +5028,19 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @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 array $content_struct
+ * @type int $publish
+ * }
+ * @return bool|IXR_Error True on success.
*/
- function mw_editPost($args) {
-
- $this->escape($args);
+ public function mw_editPost( $args ) {
+ $this->escape( $args );
$post_ID = (int) $args[0];
$username = $args[1];
@@ -4362,13 +5051,15 @@ class wp_xmlrpc_server extends IXR_Server {
if ( ! $user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'metaWeblog.editPost');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'metaWeblog.editPost' );
$postdata = get_post( $post_ID, ARRAY_A );
- // If there is no post data for the give post id, stop
- // now and return an error. Other wise a new post will be
- // created (which was the old behavior).
+ /*
+ * If there is no post data for the give post id, stop now and return an error.
+ * Otherwise a new post will be created (which was the old behavior).
+ */
if ( ! $postdata || empty( $postdata[ 'ID' ] ) )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
@@ -4392,10 +5083,17 @@ class wp_xmlrpc_server extends IXR_Server {
}
$this->escape($postdata);
- extract($postdata, EXTR_SKIP);
+
+ $ID = $postdata['ID'];
+ $post_content = $postdata['post_content'];
+ $post_title = $postdata['post_title'];
+ $post_excerpt = $postdata['post_excerpt'];
+ $post_password = $postdata['post_password'];
+ $post_parent = $postdata['post_parent'];
+ $post_type = $postdata['post_type'];
+ $menu_order = $postdata['menu_order'];
// Let WordPress manage slug if none was provided.
- $post_name = "";
$post_name = $postdata['post_name'];
if ( isset($content_struct['wp_slug']) )
$post_name = $content_struct['wp_slug'];
@@ -4412,27 +5110,33 @@ class wp_xmlrpc_server extends IXR_Server {
if ( isset($content_struct['wp_page_order']) )
$menu_order = $content_struct['wp_page_order'];
+ $page_template = null;
if ( ! empty( $content_struct['wp_page_template'] ) && 'page' == $post_type )
$page_template = $content_struct['wp_page_template'];
$post_author = $postdata['post_author'];
// Only set the post_author if one is set.
- if ( isset($content_struct['wp_author_id']) && ($user->ID != $content_struct['wp_author_id']) ) {
- switch ( $post_type ) {
- case 'post':
- if ( !current_user_can('edit_others_posts') )
- return(new IXR_Error(401, __('You are not allowed to change the post author as this user.')));
- break;
- case 'page':
- if ( !current_user_can('edit_others_pages') )
- return(new IXR_Error(401, __('You are not allowed to change the page author as this user.')));
- break;
- default:
- return(new IXR_Error(401, __('Invalid post type')));
- break;
+ if ( isset( $content_struct['wp_author_id'] ) ) {
+ // Check permissions if attempting to switch author to or from another user.
+ if ( $user->ID != $content_struct['wp_author_id'] || $user->ID != $post_author ) {
+ switch ( $post_type ) {
+ case 'post':
+ if ( ! current_user_can( 'edit_others_posts' ) ) {
+ return new IXR_Error( 401, __( 'You are not allowed to change the post author as this user.' ) );
+ }
+ break;
+ case 'page':
+ if ( ! current_user_can( 'edit_others_pages' ) ) {
+ return new IXR_Error( 401, __( 'You are not allowed to change the page author as this user.' ) );
+ }
+ break;
+ default:
+ return new IXR_Error( 401, __( 'Invalid post type' ) );
+ break;
+ }
+ $post_author = $content_struct['wp_author_id'];
}
- $post_author = $content_struct['wp_author_id'];
}
if ( isset($content_struct['mt_allow_comments']) ) {
@@ -4445,7 +5149,7 @@ class wp_xmlrpc_server extends IXR_Server {
$comment_status = 'open';
break;
default:
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
break;
}
} else {
@@ -4458,7 +5162,7 @@ class wp_xmlrpc_server extends IXR_Server {
$comment_status = 'open';
break;
default:
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
break;
}
}
@@ -4474,7 +5178,7 @@ class wp_xmlrpc_server extends IXR_Server {
$ping_status = 'open';
break;
default:
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
break;
}
} else {
@@ -4486,7 +5190,7 @@ class wp_xmlrpc_server extends IXR_Server {
$ping_status = 'open';
break;
default:
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
break;
}
}
@@ -4530,11 +5234,12 @@ class wp_xmlrpc_server extends IXR_Server {
$tags_input = isset( $content_struct['mt_keywords'] ) ? $content_struct['mt_keywords'] : null;
- if ( ('publish' == $post_status) ) {
- if ( ( 'page' == $post_type ) && !current_user_can('publish_pages') )
- return new IXR_Error(401, __('Sorry, you do not have the right to publish this page.'));
- else if ( !current_user_can('publish_posts') )
- return new IXR_Error(401, __('Sorry, you do not have the right to publish this post.'));
+ if ( 'publish' == $post_status || 'private' == $post_status ) {
+ if ( 'page' == $post_type && ! current_user_can( 'publish_pages' ) ) {
+ return new IXR_Error( 401, __( 'Sorry, you do not have the right to publish this page.' ) );
+ } elseif ( ! current_user_can( 'publish_posts' ) ) {
+ return new IXR_Error( 401, __( 'Sorry, you do not have the right to publish this post.' ) );
+ }
}
if ( $post_more )
@@ -4547,9 +5252,9 @@ class wp_xmlrpc_server extends IXR_Server {
$to_ping = implode(' ', $to_ping);
}
- // Do some timestamp voodoo
+ // Do some timestamp voodoo.
if ( !empty( $content_struct['date_created_gmt'] ) )
- // We know this is supposed to be GMT, so we're going to slap that Z on there by force
+ // We know this is supposed to be GMT, so we're going to slap that Z on there by force.
$dateCreated = rtrim( $content_struct['date_created_gmt']->getIso(), 'Z' ) . 'Z';
elseif ( !empty( $content_struct['dateCreated']) )
$dateCreated = $content_struct['dateCreated']->getIso();
@@ -4562,7 +5267,7 @@ class wp_xmlrpc_server extends IXR_Server {
$post_date_gmt = $postdata['post_date_gmt'];
}
- // We've got all the data -- post it:
+ // We've got all the data -- post it.
$newpost = compact('ID', 'post_content', 'post_title', 'post_category', 'post_status', 'post_excerpt', 'comment_status', 'ping_status', 'post_date', 'post_date_gmt', 'to_ping', 'post_name', 'post_password', 'post_parent', 'menu_order', 'post_author', 'tags_input', 'page_template');
$result = wp_update_post($newpost, true);
@@ -4574,17 +5279,21 @@ class wp_xmlrpc_server extends IXR_Server {
// Only posts can be sticky
if ( $post_type == 'post' && isset( $content_struct['sticky'] ) ) {
- if ( $content_struct['sticky'] == true )
- stick_post( $post_ID );
- elseif ( $content_struct['sticky'] == false )
- unstick_post( $post_ID );
+ $data = $newpost;
+ $data['sticky'] = $content_struct['sticky'];
+ $data['post_type'] = 'post';
+ $error = $this->_toggle_sticky( $data, true );
+ if ( $error ) {
+ return $error;
+ }
}
if ( isset($content_struct['custom_fields']) )
$this->set_custom_fields($post_ID, $content_struct['custom_fields']);
if ( isset ( $content_struct['wp_post_thumbnail'] ) ) {
- // empty value deletes, non-empty value adds/updates
+
+ // Empty value deletes, non-empty value adds/updates.
if ( empty( $content_struct['wp_post_thumbnail'] ) ) {
delete_post_thumbnail( $post_ID );
} else {
@@ -4594,17 +5303,24 @@ class wp_xmlrpc_server extends IXR_Server {
unset( $content_struct['wp_post_thumbnail'] );
}
- // Handle enclosures
+ // Handle enclosures.
$thisEnclosure = isset($content_struct['enclosure']) ? $content_struct['enclosure'] : null;
$this->add_enclosure_if_new($post_ID, $thisEnclosure);
$this->attach_uploads( $ID, $post_content );
- // Handle post formats if assigned, validation is handled
- // earlier in this function
+ // Handle post formats if assigned, validation is handled earlier in this function.
if ( isset( $content_struct['wp_post_format'] ) )
set_post_format( $post_ID, $content_struct['wp_post_format'] );
+ /**
+ * Fires after a post has been successfully updated via the XML-RPC MovableType API.
+ *
+ * @since 3.4.0
+ *
+ * @param int $post_ID ID of the updated post.
+ * @param array $args An array of arguments to update the post.
+ */
do_action( 'xmlrpc_call_success_mw_editPost', $post_ID, $args );
return true;
@@ -4615,16 +5331,22 @@ 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 mw_getPost($args) {
-
- $this->escape($args);
+ public function mw_getPost( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $post_ID = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
@@ -4636,7 +5358,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_post', $post_ID ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
- do_action('xmlrpc_call', 'metaWeblog.getPost');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'metaWeblog.getPost' );
if ($postdata['post_date'] != '') {
$post_date = $this->_convert_date( $postdata['post_date'] );
@@ -4739,16 +5462,21 @@ 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
+ * @type int $numberposts
+ * }
+ * @return array|IXR_Error
*/
- function mw_getRecentPosts($args) {
-
- $this->escape($args);
+ public function mw_getRecentPosts( $args ) {
+ $this->escape( $args );
- $blog_ID = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( isset( $args[3] ) )
$query = array( 'numberposts' => absint( $args[3] ) );
else
@@ -4757,14 +5485,18 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'metaWeblog.getRecentPosts');
+ if ( ! current_user_can( 'edit_posts' ) )
+ return new IXR_Error( 401, __( 'Sorry, you cannot edit posts on this site.' ) );
+
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'metaWeblog.getRecentPosts' );
$posts_list = wp_get_recent_posts( $query );
if ( !$posts_list )
return array();
- $struct = array();
+ $recent_posts = array();
foreach ($posts_list as $entry) {
if ( !current_user_can( 'edit_post', $entry['ID'] ) )
continue;
@@ -4808,7 +5540,7 @@ class wp_xmlrpc_server extends IXR_Server {
if ( empty( $post_format ) )
$post_format = 'standard';
- $struct[] = array(
+ $recent_posts[] = array(
'dateCreated' => $post_date,
'userid' => $entry['post_author'],
'postid' => (string) $entry['ID'],
@@ -4834,16 +5566,10 @@ class wp_xmlrpc_server extends IXR_Server {
'custom_fields' => $this->get_custom_fields($entry['ID']),
'wp_post_format' => $post_format,
'date_modified' => $post_modified,
- 'date_modified_gmt' => $post_modified_gmt
+ 'date_modified_gmt' => $post_modified_gmt,
+ 'sticky' => ( $entry['post_type'] === 'post' && is_sticky( $entry['ID'] ) ),
+ 'wp_post_thumbnail' => get_post_thumbnail_id( $entry['ID'] )
);
-
- $entry_index = count( $struct ) - 1;
- $struct[ $entry_index ][ 'wp_post_thumbnail' ] = get_post_thumbnail_id( $entry['ID'] );
- }
-
- $recent_posts = array();
- for ( $j=0; $jescape($args);
+ public function mw_getCategories( $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;
@@ -4871,12 +5601,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 categories.' ) );
- do_action('xmlrpc_call', 'metaWeblog.getCategories');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'metaWeblog.getCategories' );
$categories_struct = array();
if ( $cats = get_categories(array('get' => 'all')) ) {
foreach ( $cats as $cat ) {
+ $struct = array();
$struct['categoryId'] = $cat->term_id;
$struct['parentId'] = $cat->parent;
$struct['description'] = $cat->name;
@@ -4901,16 +5633,24 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return array
+ * @global wpdb $wpdb
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $data
+ * }
+ * @return array|IXR_Error
*/
- function mw_newMediaObject($args) {
+ public function mw_newMediaObject( $args ) {
global $wpdb;
- $blog_ID = (int) $args[0];
- $username = $wpdb->escape($args[1]);
- $password = $wpdb->escape($args[2]);
- $data = $args[3];
+ $username = $this->escape( $args[1] );
+ $password = $this->escape( $args[2] );
+ $data = $args[3];
$name = sanitize_file_name( $data['name'] );
$type = $data['type'];
@@ -4919,15 +5659,27 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'metaWeblog.newMediaObject');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'metaWeblog.newMediaObject' );
if ( !current_user_can('upload_files') ) {
$this->error = new IXR_Error( 401, __( 'You do not have permission to upload files.' ) );
return $this->error;
}
- if ( $upload_err = apply_filters( 'pre_upload_error', false ) )
- return new IXR_Error(500, $upload_err);
+ /**
+ * Filter whether to preempt the XML-RPC media upload.
+ *
+ * Passing a truthy value will effectively short-circuit the media upload,
+ * returning that value as a 500 error instead.
+ *
+ * @since 2.1.0
+ *
+ * @param bool $error Whether to pre-empt the media upload. Default false.
+ */
+ if ( $upload_err = apply_filters( 'pre_upload_error', false ) ) {
+ return new IXR_Error( 500, $upload_err );
+ }
if ( !empty($data['overwrite']) && ($data['overwrite'] == true) ) {
// Get postmeta info on the object.
@@ -4973,6 +5725,14 @@ class wp_xmlrpc_server extends IXR_Server {
$id = wp_insert_attachment( $attachment, $upload[ 'file' ], $post_id );
wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $upload['file'] ) );
+ /**
+ * Fires after a new attachment has been added via the XML-RPC MovableType API.
+ *
+ * @since 3.4.0
+ *
+ * @param int $id ID of the new attachment.
+ * @param array $args An array of arguments to add the attachment.
+ */
do_action( 'xmlrpc_call_success_mw_newMediaObject', $id, $args );
$struct = array(
@@ -4981,6 +5741,8 @@ class wp_xmlrpc_server extends IXR_Server {
'url' => $upload[ 'url' ],
'type' => $type
);
+
+ /** This filter is documented in wp-admin/includes/file.php */
return apply_filters( 'wp_handle_upload', $struct, 'upload' );
}
@@ -4993,16 +5755,21 @@ 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
+ * @type int $numberposts
+ * }
+ * @return array|IXR_Error
*/
- function mt_getRecentPostTitles($args) {
-
- $this->escape($args);
+ public function mt_getRecentPostTitles( $args ) {
+ $this->escape( $args );
- $blog_ID = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( isset( $args[3] ) )
$query = array( 'numberposts' => absint( $args[3] ) );
else
@@ -5011,7 +5778,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'mt.getRecentPostTitles');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'mt.getRecentPostTitles' );
$posts_list = wp_get_recent_posts( $query );
@@ -5020,7 +5788,7 @@ class wp_xmlrpc_server extends IXR_Server {
return $this->error;
}
- $struct = array();
+ $recent_posts = array();
foreach ($posts_list as $entry) {
if ( !current_user_can( 'edit_post', $entry['ID'] ) )
@@ -5029,7 +5797,7 @@ class wp_xmlrpc_server extends IXR_Server {
$post_date = $this->_convert_date( $entry['post_date'] );
$post_date_gmt = $this->_convert_date_gmt( $entry['post_date_gmt'], $entry['post_date'] );
- $struct[] = array(
+ $recent_posts[] = array(
'dateCreated' => $post_date,
'userid' => $entry['post_author'],
'postid' => (string) $entry['ID'],
@@ -5037,12 +5805,6 @@ class wp_xmlrpc_server extends IXR_Server {
'post_status' => $entry['post_status'],
'date_created_gmt' => $post_date_gmt
);
-
- }
-
- $recent_posts = array();
- for ( $j=0; $jescape($args);
+ public function mt_getCategoryList( $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;
@@ -5070,12 +5836,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 categories.' ) );
- do_action('xmlrpc_call', 'mt.getCategoryList');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'mt.getCategoryList' );
$categories_struct = array();
if ( $cats = get_categories(array('hide_empty' => 0, 'hierarchical' => 0)) ) {
foreach ( $cats as $cat ) {
+ $struct = array();
$struct['categoryId'] = $cat->term_id;
$struct['categoryName'] = $cat->name;
@@ -5091,16 +5859,21 @@ 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 $post_ID
+ * @type string $username
+ * @type string $password
+ * }
+ * @return array|IXR_Error
*/
- function mt_getPostCategories($args) {
-
- $this->escape($args);
+ public function mt_getPostCategories( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $post_ID = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
@@ -5111,7 +5884,8 @@ class wp_xmlrpc_server extends IXR_Server {
if ( !current_user_can( 'edit_post', $post_ID ) )
return new IXR_Error( 401, __( 'Sorry, you can not edit this post.' ) );
- do_action('xmlrpc_call', 'mt.getPostCategories');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'mt.getPostCategories' );
$categories = array();
$catids = wp_get_post_categories(intval($post_ID));
@@ -5134,22 +5908,29 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return bool True on success.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * @type array $categories
+ * }
+ * @return true|IXR_Error True on success.
*/
- function mt_setPostCategories($args) {
-
- $this->escape($args);
+ public function mt_setPostCategories( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[0];
- $username = $args[1];
+ $post_ID = (int) $args[0];
+ $username = $args[1];
$password = $args[2];
- $categories = $args[3];
+ $categories = $args[3];
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'mt.setPostCategories');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'mt.setPostCategories' );
if ( ! get_post( $post_ID ) )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
@@ -5172,31 +5953,32 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters.
* @return array
*/
- function mt_supportedMethods($args) {
-
- do_action('xmlrpc_call', 'mt.supportedMethods');
+ public function mt_supportedMethods() {
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'mt.supportedMethods' );
- $supported_methods = array();
- foreach ( $this->methods as $key => $value ) {
- $supported_methods[] = $key;
- }
-
- return $supported_methods;
+ return array_keys( $this->methods );
}
/**
* Retrieve an empty array because we don't support per-post text filters.
*
* @since 1.5.0
- *
- * @param array $args Method parameters.
*/
- function mt_supportedTextFilters($args) {
- do_action('xmlrpc_call', 'mt.supportedTextFilters');
- return apply_filters('xmlrpc_text_filters', array());
+ public function mt_supportedTextFilters() {
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'mt.supportedTextFilters' );
+
+ /**
+ * Filter the MoveableType text filters list for XML-RPC.
+ *
+ * @since 2.2.0
+ *
+ * @param array $filters An array of text filters.
+ */
+ return apply_filters( 'xmlrpc_text_filters', array() );
}
/**
@@ -5204,16 +5986,16 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return mixed
+ * @global wpdb $wpdb
+ *
+ * @param int $post_ID
+ * @return array|IXR_Error
*/
- function mt_getTrackbackPings($args) {
-
+ public function mt_getTrackbackPings( $post_ID ) {
global $wpdb;
- $post_ID = intval($args);
-
- do_action('xmlrpc_call', 'mt.getTrackbackPings');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'mt.getTrackbackPings' );
$actual_post = get_post($post_ID, ARRAY_A);
@@ -5246,21 +6028,27 @@ 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 $post_ID
+ * @type string $username
+ * @type string $password
+ * }
+ * @return int|IXR_Error
*/
- function mt_publishPost($args) {
-
- $this->escape($args);
+ public function mt_publishPost( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $post_ID = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'mt.publishPost');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'mt.publishPost' );
$postdata = get_post($post_ID, ARRAY_A);
if ( ! $postdata )
@@ -5276,9 +6064,7 @@ class wp_xmlrpc_server extends IXR_Server {
$postdata['post_category'] = $cats;
$this->escape($postdata);
- $result = wp_update_post($postdata);
-
- return $result;
+ return wp_update_post( $postdata );
}
/* PingBack functions
@@ -5290,26 +6076,39 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return array
+ * @global wpdb $wpdb
+ * @global string $wp_version
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type string $pagelinkedfrom
+ * @type string $pagelinkedto
+ * }
+ * @return string|IXR_Error
*/
- function pingback_ping($args) {
- global $wpdb;
+ public function pingback_ping( $args ) {
+ global $wpdb, $wp_version;
- do_action('xmlrpc_call', 'pingback.ping');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'pingback.ping' );
- $this->escape($args);
-
- $pagelinkedfrom = $args[0];
- $pagelinkedto = $args[1];
-
- $title = '';
-
- $pagelinkedfrom = str_replace('&', '&', $pagelinkedfrom);
- $pagelinkedto = str_replace('&', '&', $pagelinkedto);
- $pagelinkedto = str_replace('&', '&', $pagelinkedto);
+ $this->escape( $args );
+ $pagelinkedfrom = str_replace( '&', '&', $args[0] );
+ $pagelinkedto = str_replace( '&', '&', $args[1] );
+ $pagelinkedto = str_replace( '&', '&', $pagelinkedto );
+
+ /**
+ * Filter the pingback source URI.
+ *
+ * @since 3.6.0
+ *
+ * @param string $pagelinkedfrom URI of the page linked from.
+ * @param string $pagelinkedto URI of the page linked to.
+ */
$pagelinkedfrom = apply_filters( 'pingback_ping_source_uri', $pagelinkedfrom, $pagelinkedto );
+
if ( ! $pagelinkedfrom )
return $this->pingback_error( 0, __( 'A valid URL was not provided.' ) );
@@ -5323,36 +6122,31 @@ class wp_xmlrpc_server extends IXR_Server {
// if so, then let's use it and drop the old code.
$urltest = parse_url($pagelinkedto);
if ( $post_ID = url_to_postid($pagelinkedto) ) {
- $way = 'url_to_postid()';
- } elseif ( preg_match('#p/[0-9]{1,}#', $urltest['path'], $match) ) {
+ // $way
+ } elseif ( isset( $urltest['path'] ) && preg_match('#p/[0-9]{1,}#', $urltest['path'], $match) ) {
// the path defines the post_ID (archives/p/XXXX)
$blah = explode('/', $match[0]);
$post_ID = (int) $blah[1];
- $way = 'from the path';
} elseif ( isset( $urltest['query'] ) && preg_match('#p=[0-9]{1,}#', $urltest['query'], $match) ) {
// the querystring defines the post_ID (?p=XXXX)
$blah = explode('=', $match[0]);
$post_ID = (int) $blah[1];
- $way = 'from the querystring';
} elseif ( isset($urltest['fragment']) ) {
// an #anchor is there, it's either...
if ( intval($urltest['fragment']) ) {
// ...an integer #XXXX (simplest case)
$post_ID = (int) $urltest['fragment'];
- $way = 'from the fragment (numeric)';
} elseif ( preg_match('/post-[0-9]+/',$urltest['fragment']) ) {
// ...a post id in the form 'post-###'
$post_ID = preg_replace('/[^0-9]+/', '', $urltest['fragment']);
- $way = 'from the fragment (post-###)';
} elseif ( is_string($urltest['fragment']) ) {
// ...or a string #title, a little more complicated
$title = preg_replace('/[^a-z0-9]/i', '.', $urltest['fragment']);
- $sql = $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_title RLIKE %s", like_escape( $title ) );
+ $sql = $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_title RLIKE %s", $title );
if (! ($post_ID = $wpdb->get_var($sql)) ) {
// returning unknown error '0' is better than die()ing
return $this->pingback_error( 0, '' );
}
- $way = 'from the fragment (title)';
}
} else {
// TODO: Attempt to extract a post ID from the given URL
@@ -5379,17 +6173,40 @@ class wp_xmlrpc_server extends IXR_Server {
// very stupid, but gives time to the 'from' server to publish !
sleep(1);
+ $remote_ip = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );
+
+ /** This filter is documented in wp-includes/class-http.php */
+ $user_agent = apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ) );
+
// Let's check the remote site
- $linea = wp_remote_retrieve_body( wp_remote_get( $pagelinkedfrom, array( 'timeout' => 10, 'redirection' => 0, 'reject_unsafe_urls' => true ) ) );
+ $http_api_args = array(
+ 'timeout' => 10,
+ 'redirection' => 0,
+ 'limit_response_size' => 153600, // 150 KB
+ 'user-agent' => "$user_agent; verifying pingback from $remote_ip",
+ 'headers' => array(
+ 'X-Pingback-Forwarded-For' => $remote_ip,
+ ),
+ );
+ $request = wp_safe_remote_get( $pagelinkedfrom, $http_api_args );
+ $linea = wp_remote_retrieve_body( $request );
if ( !$linea )
- return $this->pingback_error( 16, __( 'The source URL does not exist.' ) );
-
- $linea = apply_filters('pre_remote_source', $linea, $pagelinkedto);
+ return $this->pingback_error( 16, __( 'The source URL does not exist.' ) );
+
+ /**
+ * Filter the pingback remote source.
+ *
+ * @since 2.5.0
+ *
+ * @param string $linea Response object for the page linked from.
+ * @param string $pagelinkedto URL of the page linked to.
+ */
+ $linea = apply_filters( 'pre_remote_source', $linea, $pagelinkedto );
// Work around bug in strip_tags():
$linea = str_replace(']*>/", "\n\n", $linea );
preg_match('|([^<]*?)|is', $linea, $matchtitle);
@@ -5417,7 +6234,7 @@ class wp_xmlrpc_server extends IXR_Server {
// prevent really long link text
if ( strlen($context[1]) > 100 )
- $context[1] = substr($context[1], 0, 100) . '...';
+ $context[1] = substr($context[1], 0, 100) . '…';
$marker = ''.$context[1].''; // set up our marker
$excerpt= str_replace($context[0], $marker, $excerpt); // swap out the link for our marker
@@ -5435,8 +6252,8 @@ class wp_xmlrpc_server extends IXR_Server {
$pagelinkedfrom = str_replace('&', '&', $pagelinkedfrom);
- $context = '[...] ' . esc_html( $excerpt ) . ' [...]';
- $pagelinkedfrom = $wpdb->escape( $pagelinkedfrom );
+ $context = '[…] ' . esc_html( $excerpt ) . ' […]';
+ $pagelinkedfrom = $this->escape( $pagelinkedfrom );
$comment_post_ID = (int) $post_ID;
$comment_author = $title;
@@ -5450,7 +6267,15 @@ class wp_xmlrpc_server extends IXR_Server {
$commentdata = compact('comment_post_ID', 'comment_author', 'comment_author_url', 'comment_author_email', 'comment_content', 'comment_type');
$comment_ID = wp_new_comment($commentdata);
- do_action('pingback_post', $comment_ID);
+
+ /**
+ * Fires after a post pingback has been sent.
+ *
+ * @since 0.71
+ *
+ * @param int $comment_ID Comment ID.
+ */
+ do_action( 'pingback_post', $comment_ID );
return sprintf(__('Pingback from %1$s to %2$s registered. Keep the web talking! :-)'), $pagelinkedfrom, $pagelinkedto);
}
@@ -5462,18 +6287,18 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return array
+ * @global wpdb $wpdb
+ *
+ * @param string $url
+ * @return array|IXR_Error
*/
- function pingback_extensions_getPingbacks($args) {
-
+ public function pingback_extensions_getPingbacks( $url ) {
global $wpdb;
- do_action('xmlrpc_call', 'pingback.extensions.getPingbacks');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'pingback.extensions.getPingbacks' );
- $this->escape($args);
-
- $url = $args;
+ $url = $this->escape( $url );
$post_ID = url_to_postid($url);
if ( !$post_ID ) {
@@ -5502,7 +6327,19 @@ class wp_xmlrpc_server extends IXR_Server {
return $pingbacks;
}
+ /**
+ * @param integer $code
+ * @param string $message
+ * @return IXR_Error
+ */
protected function pingback_error( $code, $message ) {
+ /**
+ * Filter the XML-RPC pingback error return.
+ *
+ * @since 3.5.1
+ *
+ * @param IXR_Error $error An IXR_Error object containing the error code and message.
+ */
return apply_filters( 'xmlrpc_pingback_error', new IXR_Error( $code, $message ) );
}
}