* XML-RPC protocol support for WordPress
*
* @package WordPress
+ * @subpackage Publishing
*/
/**
* 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 {
-
+ /**
+ * @var array
+ */
+ public $methods;
+ /**
+ * @var array
+ */
+ public $blog_options;
+ /**
+ * @var IXR_Error
+ */
+ public $error;
/**
* Register all of the XMLRPC methods that XMLRPC server understands.
*
* 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',
'wp.getTerms' => 'this:wp_getTerms',
'wp.getTaxonomy' => 'this:wp_getTaxonomy',
'wp.getTaxonomies' => 'this:wp_getTaxonomies',
+ 'wp.getUser' => 'this:wp_getUser',
+ 'wp.getUsers' => 'this:wp_getUsers',
+ 'wp.getProfile' => 'this:wp_getProfile',
+ 'wp.editProfile' => 'this:wp_editProfile',
'wp.getPage' => 'this:wp_getPage',
'wp.getPages' => 'this:wp_getPages',
'wp.newPage' => 'this:wp_newPage',
'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',
'wp.getPostFormats' => 'this:wp_getPostFormats',
'wp.getPostType' => 'this:wp_getPostType',
'wp.getPostTypes' => 'this:wp_getPostTypes',
+ 'wp.getRevisions' => 'this:wp_getRevisions',
+ 'wp.restoreRevision' => 'this:wp_restoreRevision',
// Blogger API
'blogger.getUsersBlogs' => 'this:blogger_getUsersBlogs',
'blogger.getUserInfo' => 'this:blogger_getUserInfo',
'blogger.getPost' => 'this:blogger_getPost',
'blogger.getRecentPosts' => 'this:blogger_getRecentPosts',
- 'blogger.getTemplate' => 'this:blogger_getTemplate',
- 'blogger.setTemplate' => 'this:blogger_setTemplate',
'blogger.newPost' => 'this:blogger_newPost',
'blogger.editPost' => 'this:blogger_editPost',
'blogger.deletePost' => 'this:blogger_deletePost',
// MetaWeblog API aliases for Blogger API
// see http://www.xmlrpc.com/stories/storyReader$2460
'metaWeblog.deletePost' => 'this:blogger_deletePost',
- 'metaWeblog.getTemplate' => 'this:blogger_getTemplate',
- 'metaWeblog.setTemplate' => 'this:blogger_setTemplate',
'metaWeblog.getUsersBlogs' => 'this:blogger_getUsersBlogs',
// MovableType API
);
$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 );
}
- function serve_request() {
+ /**
+ * 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 mixed|bool 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;
+ }
+
+ public function serve_request() {
$this->IXR_Server($this->methods);
}
* @param array $args Method Parameters.
* @return string
*/
- function sayHello($args) {
+ public function sayHello($args) {
return 'Hello!';
}
* @param array $args Method Parameters.
* @return int
*/
- function addTwoNumbers($args) {
+ public function addTwoNumbers($args) {
$number1 = $args[0];
$number2 = $args[1];
return $number1 + $number2;
}
- /**
- * Check user's credentials.
- *
- * @since 1.5.0
- *
- * @param string $user_login User's username.
- * @param string $user_pass User's password.
- * @return bool Whether authentication passed.
- * @deprecated use wp_xmlrpc_server::login
- * @see wp_xmlrpc_server::login
- */
- function login_pass_ok($user_login, $user_pass) {
- if ( !get_option( 'enable_xmlrpc' ) ) {
- $this->error = new IXR_Error( 405, sprintf( __( 'XML-RPC services are disabled on this site. An admin user can enable them at %s'), admin_url('options-writing.php') ) );
- return false;
- }
-
- if (!user_pass_ok($user_login, $user_pass)) {
- $this->error = new IXR_Error(403, __('Bad login/pass combination.'));
- return false;
- }
- return true;
- }
-
/**
* Log user in.
*
- * @since 2.8
+ * @since 2.8.0
*
* @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) {
- if ( !get_option( 'enable_xmlrpc' ) ) {
- $this->error = new IXR_Error( 405, sprintf( __( 'XML-RPC services are disabled on this site. An admin user can enable them at %s'), admin_url('options-writing.php') ) );
+ public function login( $username, $password ) {
+ /*
+ * Respect old get_option() filters left for back-compat when the 'enable_xmlrpc'
+ * option was deprecated in 3.5.0. Use the 'xmlrpc_enabled' hook instead.
+ */
+ $enabled = apply_filters( 'pre_option_enable_xmlrpc', false );
+ if ( false === $enabled ) {
+ $enabled = apply_filters( 'option_enable_xmlrpc', true );
+ }
+
+ /**
+ * 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 ) {
+ $this->error = new IXR_Error( 405, sprintf( __( 'XML-RPC services are disabled on this site.' ) ) );
return false;
}
$user = wp_authenticate($username, $password);
if (is_wp_error($user)) {
- $this->error = new IXR_Error(403, __('Bad login/pass combination.'));
+ $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;
}
}
/**
- * Sanitize string or array of strings for database.
+ * Check user's credentials. Deprecated.
*
- * @since 1.5.2
+ * @since 1.5.0
+ * @deprecated 2.8.0
+ * @deprecated use wp_xmlrpc_server::login
+ * @see wp_xmlrpc_server::login
*
- * @param string|array $array Sanitize single string or array of strings.
- * @return string|array Type matches $array and sanitized for the database.
+ * @param string $username User's username.
+ * @param string $password User's password.
+ * @return bool Whether authentication passed.
*/
- function escape(&$array) {
- global $wpdb;
+ public function login_pass_ok( $username, $password ) {
+ return (bool) $this->login( $username, $password );
+ }
- 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);
- }
- }
+ /**
+ * Escape string or array of strings for database.
+ *
+ * @since 1.5.2
+ *
+ * @param string|array $data Escape single string or array of strings.
+ * @return string|array Type matches $data and sanitized for the database.
+ */
+ 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 );
}
}
* @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();
* @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 ) {
$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'] );
}
}
*
* @since 2.6.0
*/
- function initialise_blog_option_info() {
+ public function initialise_blog_option_info() {
global $wp_version;
$this->blog_options = array(
'value' => $wp_version
),
'blog_url' => array(
- 'desc' => __( 'Site URL' ),
+ 'desc' => __( 'WordPress Address (URL)' ),
'readonly' => true,
'option' => 'siteurl'
),
+ 'home_url' => array(
+ 'desc' => __( 'Site Address (URL)' ),
+ 'readonly' => true,
+ 'option' => 'home'
+ ),
+ 'login_url' => array(
+ 'desc' => __( 'Login Address (URL)' ),
+ 'readonly' => true,
+ 'value' => wp_login_url( )
+ ),
+ 'admin_url' => array(
+ 'desc' => __( 'The URL to the admin area' ),
+ 'readonly' => true,
+ 'value' => get_admin_url( )
+ ),
'image_default_link_type' => array(
'desc' => __( 'Image default link type' ),
'readonly' => true,
)
);
+ /**
+ * 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 );
}
* @param array $args Method parameters. Contains:
* - username
* - password
- * @return array. Contains:
+ * @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 );
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 method $name The method name.
+ */
do_action( 'xmlrpc_call', 'wp.getUsersBlogs' );
$blogs = (array) get_blogs_of_user( $user->ID );
foreach ( $blogs as $blog ) {
// Don't include blogs that aren't hosted at this site
- if ( $blog->site_id != $current_site->id )
+ if ( $blog->site_id != get_current_site()->id )
continue;
$blog_id = $blog->userblog_id;
- switch_to_blog($blog_id);
- $is_admin = current_user_can('manage_options');
+
+ switch_to_blog( $blog_id );
+
+ $is_admin = current_user_can( 'manage_options' );
$struct[] = array(
'isAdmin' => $is_admin,
- 'url' => get_option( 'home' ) . '/',
+ 'url' => home_url( '/' ),
'blogid' => (string) $blog_id,
'blogName' => get_option( 'blogname' ),
- 'xmlrpc' => site_url( 'xmlrpc.php' )
+ 'xmlrpc' => site_url( 'xmlrpc.php', 'rpc' ),
);
restore_current_blog();
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 );
}
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 );
}
'post_password' => $post['post_password'],
'post_excerpt' => $post['post_excerpt'],
'post_content' => $post['post_content'],
+ 'post_parent' => strval( $post['post_parent'] ),
+ 'post_mime_type' => $post['post_mime_type'],
'link' => post_permalink( $post['ID'] ),
+ 'guid' => $post['guid'],
+ 'menu_order' => intval( $post['menu_order'] ),
'comment_status' => $post['comment_status'],
'ping_status' => $post['ping_status'],
'sticky' => ( $post['post_type'] === 'post' && is_sticky( $post['ID'] ) ),
}
}
+ /**
+ * 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 );
}
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 );
}
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 );
}
// Get info the page parent if there is one.
$parent_title = "";
if ( ! empty( $page->post_parent ) ) {
- $parent = get_page( $page->post_parent );
+ $parent = get_post( $page->post_parent );
$parent_title = $parent->post_title;
}
// 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.
'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 );
}
*/
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,
'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 );
}
+ /**
+ * Prepares user data for return in an XML-RPC object.
+ *
+ * @access protected
+ *
+ * @param WP_User $user The unprepared user object
+ * @param array $fields The subset of user fields to return
+ * @return array The prepared user data
+ */
+ protected function _prepare_user( $user, $fields ) {
+ $_user = array( 'user_id' => strval( $user->ID ) );
+
+ $user_fields = array(
+ 'username' => $user->user_login,
+ 'first_name' => $user->user_firstname,
+ 'last_name' => $user->user_lastname,
+ 'registered' => $this->_convert_date( $user->user_registered ),
+ 'bio' => $user->user_description,
+ 'email' => $user->user_email,
+ 'nickname' => $user->nickname,
+ 'nicename' => $user->user_nicename,
+ 'url' => $user->user_url,
+ 'display_name' => $user->display_name,
+ 'roles' => $user->roles,
+ );
+
+ if ( in_array( 'all', $fields ) ) {
+ $_user = array_merge( $_user, $user_fields );
+ } else {
+ if ( in_array( 'basic', $fields ) ) {
+ $basic_fields = array( 'username', 'email', 'registered', 'display_name', 'nicename' );
+ $fields = array_merge( $fields, $basic_fields );
+ }
+ $requested_fields = array_intersect_key( $user_fields, array_flip( $fields ) );
+ $_user = array_merge( $_user, $requested_fields );
+ }
+
+ /**
+ * 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 );
+ }
+
/**
* Create a new post for any registered post type.
*
* @since 3.4.0
*
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - array $content_struct
* - post_status (default: 'draft')
* - post_title
* - post_author
- * - post_exerpt
+ * - post_excerpt
* - post_content
* - post_date_gmt | post_date
* - post_format
* - 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
+ * @return string|IXR_Error post_id
*/
- 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];
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'] );
return $count > 1;
}
+ private function _validate_boolean( $var ) {
+ if ( is_bool( $var ) ) {
+ return $var;
+ }
+
+ if ( is_string( $var ) && 'false' === strtolower( $var ) ) {
+ return false;
+ }
+
+ return (bool) $var;
+ }
+
+ /**
+ * Encapsulate the logic for sticking a post
+ * and determining if the user has permission to do so
+ *
+ * @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 = $this->_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.
*
* @uses wp_insert_post()
*
* @param WP_User $user The post author if post_author isn't set in $content_struct.
- * @param array $content_struct Post data to insert.
+ * @param array|IXR_Error $content_struct Post data to insert.
*/
protected function _insert_post( $user, $content_struct ) {
$defaults = array( 'post_status' => 'draft', 'post_type' => 'post', 'post_author' => 0,
if ( $update ) {
if ( ! get_post( $post_data['ID'] ) )
return new IXR_Error( 401, __( 'Invalid post ID.' ) );
- if ( ! current_user_can( $post_type->cap->edit_post, $post_data['ID'] ) )
+ if ( ! current_user_can( 'edit_post', $post_data['ID'] ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) );
if ( $post_data['post_type'] != get_post_type( $post_data['ID'] ) )
return new IXR_Error( 401, __( 'The post type may not be changed.' ) );
} else {
- if ( ! current_user_can( $post_type->cap->edit_posts ) )
+ if ( ! current_user_can( $post_type->cap->create_posts ) || ! current_user_can( $post_type->cap->edit_posts ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to post on this site.' ) );
}
return new IXR_Error( 401, __( 'Sorry, you are not allowed to publish posts in this post type' ) );
break;
default:
- $post_data['post_status'] = 'draft';
+ if ( ! get_post_status_object( $post_data['post_status'] ) )
+ $post_data['post_status'] = 'draft';
break;
}
$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;
}
}
// empty value deletes, non-empty value adds/updates
if ( ! $post_data['post_thumbnail'] )
delete_post_thumbnail( $post_ID );
- elseif ( ! set_post_thumbnail( $post_ID, $post_data['post_thumbnail'] ) )
- return new IXR_Error( 404, __( 'Invalid attachment ID.' ) );
+ elseif ( ! get_post( absint( $post_data['post_thumbnail'] ) ) )
+ return new IXR_Error( 404, __( 'Invalid attachment ID.' ) );
+ set_post_thumbnail( $post_ID, $post_data['post_thumbnail'] );
unset( $content_struct['post_thumbnail'] );
}
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 );
$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 = wp_insert_post( $post_data, true );
+ $post_ID = $update ? wp_update_post( $post_data, true ) : wp_insert_post( $post_data, true );
if ( is_wp_error( $post_ID ) )
return new IXR_Error( 500, $post_ID->get_error_message() );
* @since 3.4.0
*
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - int $post_id
* - array $content_struct
- * @return true on success
+ * @return bool|IXR_Error true on success
*/
- 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];
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 );
if ( empty( $post['ID'] ) )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
+ if ( isset( $content_struct['if_not_modified_since'] ) ) {
+ // If the post has been modified since the date provided, return an error.
+ if ( mysql2date( 'U', $post['post_modified_gmt'] ) > $content_struct['if_not_modified_since']->getTimestamp() ) {
+ return new IXR_Error( 409, __( 'There is a revision of this post that is more recent.' ) );
+ }
+ }
+
// convert the date field back to IXR form
$post['post_date'] = $this->_convert_date( $post['post_date'] );
*
* @uses wp_delete_post()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - int $post_id
- * @return true on success
+ * @return bool|IXR_Error true on success
*/
- 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];
if ( ! $user = $this->login( $username, $password ) )
return $this->error;
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.deletePost' );
- $post = wp_get_single_post( $post_id, ARRAY_A );
+ $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 );
* groups are 'post' (all basic fields), 'taxonomies', 'custom_fields',
* and 'enclosure'.
*
- * @uses wp_get_single_post()
+ * @uses get_post()
* @param array $args Method parameters. Contains:
- * - int $post_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
+ * - int $post_id
* - array $fields optional
- * @return array contains (based on $fields parameter):
+ * @return array|IXR_Error Array contains (based on $fields parameter):
* - 'post_id'
* - 'post_title'
* - 'post_date'
* - '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];
- 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.
+ * @param string $method Method name.
+ */
$fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPost' );
+ }
if ( ! $user = $this->login( $username, $password ) )
return $this->error;
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getPost' );
- $post = wp_get_single_post( $post_id, ARRAY_A );
+ $post = get_post( $post_id, ARRAY_A );
if ( empty( $post['ID'] ) )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
- $post_type = get_post_type_object( $post['post_type'] );
- if ( ! current_user_can( $post_type->cap->edit_posts, $post_id ) )
+ 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 );
* @see get_posts() for more on $filter values
*
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - array $filter optional
* - array $fields optional
- * @return array contains a collection of posts.
+ * @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();
- 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();
$post_type = get_post_type_object( $filter['post_type'] );
if ( ! ( (bool) $post_type ) )
return new IXR_Error( 403, __( 'The post type specified is not valid' ) );
+ } else {
+ $post_type = get_post_type_object( 'post' );
+ }
- if ( ! current_user_can( $post_type->cap->edit_posts ) )
- return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts in this post type' ));
+ if ( ! current_user_can( $post_type->cap->edit_posts ) )
+ return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts in this post type' ));
- $query['post_type'] = $filter['post_type'];
- }
+ $query['post_type'] = $post_type->name;
if ( isset( $filter['post_status'] ) )
$query['post_status'] = $filter['post_status'];
$query['order'] = $filter['order'];
}
+ if ( isset( $filter['s'] ) ) {
+ $query['s'] = $filter['s'];
+ }
+
$posts_list = wp_get_recent_posts( $query );
if ( ! $posts_list )
$struct = array();
foreach ( $posts_list as $post ) {
- $post_type = get_post_type_object( $post['post_type'] );
- if ( ! current_user_can( $post_type->cap->edit_posts, $post['ID'] ) )
+ if ( ! current_user_can( 'edit_post', $post['ID'] ) )
continue;
$struct[] = $this->_prepare_post( $post, $fields );
*
* @uses wp_insert_term()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - array $content_struct
* - 'parent'
* - 'description'
* - 'slug'
- * @return string term_id
+ * @return string|IXR_Error term_id
*/
- 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];
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'] ) )
*
* @uses wp_update_term()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - string $term_id
* - 'parent'
* - 'description'
* - 'slug'
- * @return bool True, on success.
+ * @return bool|IXR_Error True, on success.
*/
- 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];
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'] ) )
*
* @uses wp_delete_term()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - string $taxnomy_name
* - string $term_id
* @return boolean|IXR_Error If it suceeded true else a reason why not
*/
- 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];
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 ) )
*
* @uses get_term()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - string $taxonomy
* - string $term_id
- * @return array contains:
+ * @return array|IXR_Error Array contains:
* - 'term_id'
* - 'name'
* - 'slug'
* - '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];
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 ) )
*
* @uses get_terms()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - string $taxonomy
* - array $filter optional
- * @return array terms
+ * @return array|IXR_Error terms
*/
- 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];
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 ) )
*
* @uses get_taxonomy()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - string $taxonomy
- * @return array (@see get_taxonomy())
+ * @return array|IXR_Error (@see get_taxonomy())
*/
- 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];
- 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 ) )
*
* @uses get_taxonomies()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* @return array taxonomies
*/
- 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 );
- 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' );
if ( ! current_user_can( $taxonomy->cap->assign_terms ) )
continue;
- $struct[] = $this->_prepare_taxonomy( $taxonomy, $fields );
- }
+ $struct[] = $this->_prepare_taxonomy( $taxonomy, $fields );
+ }
+
+ return $struct;
+ }
+
+ /**
+ * Retrieve a user.
+ *
+ * The optional $fields parameter specifies what fields will be included
+ * in the response array. This should be a list of field names. 'user_id' will
+ * always be included in the response regardless of the value of $fields.
+ *
+ * Instead of, or in addition to, individual field names, conceptual group
+ * names can be used to specify multiple fields. The available conceptual
+ * groups are 'basic' and 'all'.
+ *
+ * @uses get_userdata()
+ * @param array $args Method parameters. Contains:
+ * - int $blog_id (unused)
+ * - string $username
+ * - string $password
+ * - int $user_id
+ * - array $fields optional
+ * @return array|IXR_Error Array contains (based on $fields parameter):
+ * - 'user_id'
+ * - 'username'
+ * - 'first_name'
+ * - 'last_name'
+ * - 'registered'
+ * - 'bio'
+ * - 'email'
+ * - 'nickname'
+ * - 'nicename'
+ * - 'url'
+ * - 'display_name'
+ * - 'roles'
+ */
+ public function wp_getUser( $args ) {
+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
+ $this->escape( $args );
+
+ $username = $args[1];
+ $password = $args[2];
+ $user_id = (int) $args[3];
+
+ if ( isset( $args[4] ) ) {
+ $fields = $args[4];
+ } else {
+ /**
+ * Filter the default user query fields used by the given XML-RPC method.
+ *
+ * @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 ) )
+ return new IXR_Error( 401, __( 'Sorry, you cannot edit users.' ) );
+
+ $user_data = get_userdata( $user_id );
+
+ if ( ! $user_data )
+ return new IXR_Error( 404, __( 'Invalid user ID' ) );
+
+ return $this->_prepare_user( $user_data, $fields );
+ }
+
+ /**
+ * Retrieve users.
+ *
+ * The optional $filter parameter modifies the query used to retrieve users.
+ * Accepted keys are 'number' (default: 50), 'offset' (default: 0), 'role',
+ * 'who', 'orderby', and 'order'.
+ *
+ * The optional $fields parameter specifies what fields will be included
+ * in the response array.
+ *
+ * @uses get_users()
+ * @see wp_getUser() for more on $fields and return values
+ *
+ * @param array $args Method parameters. Contains:
+ * - int $blog_id (unused)
+ * - string $username
+ * - string $password
+ * - array $filter optional
+ * - array $fields optional
+ * @return array|IXR_Error users data
+ */
+ public function wp_getUsers( $args ) {
+ if ( ! $this->minimum_args( $args, 3 ) )
+ return $this->error;
+
+ $this->escape( $args );
+
+ $username = $args[1];
+ $password = $args[2];
+ $filter = isset( $args[3] ) ? $args[3] : array();
+
+ if ( isset( $args[4] ) ) {
+ $fields = $args[4];
+ } else {
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ $fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUsers' );
+ }
+
+ if ( ! $user = $this->login( $username, $password ) )
+ return $this->error;
+
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getUsers' );
+
+ if ( ! current_user_can( 'list_users' ) )
+ return new IXR_Error( 401, __( 'Sorry, you cannot list users.' ) );
+
+ $query = array( 'fields' => 'all_with_meta' );
+
+ $query['number'] = ( isset( $filter['number'] ) ) ? absint( $filter['number'] ) : 50;
+ $query['offset'] = ( isset( $filter['offset'] ) ) ? absint( $filter['offset'] ) : 0;
+
+ if ( isset( $filter['orderby'] ) ) {
+ $query['orderby'] = $filter['orderby'];
+
+ if ( isset( $filter['order'] ) )
+ $query['order'] = $filter['order'];
+ }
+
+ if ( isset( $filter['role'] ) ) {
+ if ( get_role( $filter['role'] ) === null )
+ return new IXR_Error( 403, __( 'The role specified is not valid' ) );
+
+ $query['role'] = $filter['role'];
+ }
+
+ if ( isset( $filter['who'] ) ) {
+ $query['who'] = $filter['who'];
+ }
+
+ $users = get_users( $query );
+
+ $_users = array();
+ foreach ( $users as $user_data ) {
+ if ( current_user_can( 'edit_user', $user_data->ID ) )
+ $_users[] = $this->_prepare_user( $user_data, $fields );
+ }
+ return $_users;
+ }
+
+ /**
+ * Retrieve information about the requesting user.
+ *
+ * @uses get_userdata()
+ * @param array $args Method parameters. Contains:
+ * - int $blog_id (unused)
+ * - string $username
+ * - string $password
+ * - array $fields optional
+ * @return array|IXR_Error (@see wp_getUser)
+ */
+ public function wp_getProfile( $args ) {
+ if ( ! $this->minimum_args( $args, 3 ) )
+ return $this->error;
+
+ $this->escape( $args );
+
+ $username = $args[1];
+ $password = $args[2];
+
+ if ( isset( $args[3] ) ) {
+ $fields = $args[3];
+ } else {
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ $fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getProfile' );
+ }
+
+ if ( ! $user = $this->login( $username, $password ) )
+ return $this->error;
+
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.getProfile' );
+
+ if ( ! current_user_can( 'edit_user', $user->ID ) )
+ return new IXR_Error( 401, __( 'Sorry, you cannot edit your profile.' ) );
+
+ $user_data = get_userdata( $user->ID );
+
+ return $this->_prepare_user( $user_data, $fields );
+ }
+
+ /**
+ * Edit user's profile.
+ *
+ * @uses wp_update_user()
+ * @param array $args Method parameters. Contains:
+ * - int $blog_id (unused)
+ * - string $username
+ * - string $password
+ * - array $content_struct
+ * It can optionally contain:
+ * - 'first_name'
+ * - 'last_name'
+ * - 'website'
+ * - 'display_name'
+ * - 'nickname'
+ * - 'nicename'
+ * - 'bio'
+ * @return bool|IXR_Error True, on success.
+ */
+ public function wp_editProfile( $args ) {
+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
+ $this->escape( $args );
+
+ $username = $args[1];
+ $password = $args[2];
+ $content_struct = $args[3];
+
+ if ( ! $user = $this->login( $username, $password ) )
+ return $this->error;
+
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.editProfile' );
+
+ if ( ! current_user_can( 'edit_user', $user->ID ) )
+ return new IXR_Error( 401, __( 'Sorry, you cannot edit your profile.' ) );
+
+ // holds data of the user
+ $user_data = array();
+ $user_data['ID'] = $user->ID;
+
+ // only set the user details if it was given
+ if ( isset( $content_struct['first_name'] ) )
+ $user_data['first_name'] = $content_struct['first_name'];
+
+ if ( isset( $content_struct['last_name'] ) )
+ $user_data['last_name'] = $content_struct['last_name'];
+
+ if ( isset( $content_struct['url'] ) )
+ $user_data['user_url'] = $content_struct['url'];
+
+ if ( isset( $content_struct['display_name'] ) )
+ $user_data['display_name'] = $content_struct['display_name'];
+
+ if ( isset( $content_struct['nickname'] ) )
+ $user_data['nickname'] = $content_struct['nickname'];
+
+ if ( isset( $content_struct['nicename'] ) )
+ $user_data['user_nicename'] = $content_struct['nicename'];
+
+ if ( isset( $content_struct['bio'] ) )
+ $user_data['description'] = $content_struct['bio'];
+
+ $result = wp_update_user( $user_data );
+
+ if ( is_wp_error( $result ) )
+ return new IXR_Error( 500, $result->get_error_message() );
+
+ if ( ! $result )
+ return new IXR_Error( 500, __( 'Sorry, the user cannot be updated.' ) );
- return $struct;
+ return true;
}
/**
* @since 2.2.0
*
* @param array $args Method parameters. Contains:
- * - blog_id
+ * - blog_id (unused)
* - page_id
* - username
* - password
- * @return array
+ * @return array|IXR_Error
*/
- function wp_getPage($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];
return $this->error;
}
- $page = get_page($page_id);
+ $page = get_post($page_id);
if ( ! $page )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( !current_user_can( 'edit_page', $page_id ) )
return new IXR_Error( 401, __( 'Sorry, you 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') ) {
}
// 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.' ) );
}
}
* @since 2.2.0
*
* @param array $args Method parameters. Contains:
- * - blog_id
+ * - blog_id (unused)
* - username
* - password
* - num_pages
- * @return array
+ * @return array|IXR_Error
*/
- function wp_getPages($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;
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);
$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();
}
/**
* @since 2.2.0
*
* @param array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()}
- * @return unknown
+ * @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];
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 );
}
/**
* @since 2.2.0
*
* @param array $args Method parameters.
- * @return bool True, if success.
+ * @return bool|IXR_Error True, if success.
*/
- function wp_deletePage($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];
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'wp.deletePage');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.deletePage' );
// Get the current page based on the page_id and
// make sure it is a page and not a post.
- $actual_page = wp_get_single_post($page_id, ARRAY_A);
+ $actual_page = get_post($page_id, ARRAY_A);
if ( !$actual_page || ($actual_page['post_type'] != 'page') )
- return(new IXR_Error(404, __('Sorry, no such page.')));
+ return new IXR_Error( 404, __( 'Sorry, no such page.' ) );
// Make sure the user can delete pages.
if ( !current_user_can('delete_page', $page_id) )
- return(new IXR_Error(401, __('Sorry, you do not have the right to delete this page.')));
+ return new IXR_Error( 401, __( 'Sorry, you 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;
}
/**
* @since 2.2.0
*
* @param array $args Method parameters.
- * @return unknown
+ * @return array|IXR_Error
*/
- function wp_editPage($args) {
+ public 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]);
if ( !$user = $this->login($username, $password) )
return $this->error;
- do_action('xmlrpc_call', 'wp.editPage');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.editPage' );
// Get the page data and make sure it is a page.
- $actual_page = wp_get_single_post($page_id, ARRAY_A);
+ $actual_page = get_post($page_id, ARRAY_A);
if ( !$actual_page || ($actual_page['post_type'] != 'page') )
- return(new IXR_Error(404, __('Sorry, no such page.')));
+ return new IXR_Error( 404, __( 'Sorry, no such page.' ) );
// Make sure the user is allowed to edit pages.
if ( !current_user_can('edit_page', $page_id) )
- return(new IXR_Error(401, __('Sorry, you do not have the right to edit this page.')));
+ return new IXR_Error( 401, __( 'Sorry, you do not have the right to edit this page.' ) );
// Mark this as content for a page.
$content['post_type'] = 'page';
);
// Let mw_editPost do all of the heavy lifting.
- return($this->mw_editPost($args));
+ return $this->mw_editPost( $args );
}
/**
* @since 2.2.0
*
* @param array $args Method parameters.
- * @return unknown
+ * @return array|IXR_Error
*/
- function wp_getPageList($args) {
+ public function wp_getPageList($args) {
global $wpdb;
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
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("
unset($page_list[$i]->post_status);
}
- return($page_list);
+ return $page_list;
}
/**
* @since 2.2.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function wp_getAuthors($args) {
+ public function wp_getAuthors($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
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 ) {
* @since 2.7.0
*
* @param array $args Method parameters.
- * @return array
+ * @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];
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;
* @since 2.2.0
*
* @param array $args Method parameters.
- * @return int Category ID.
+ * @return int|IXR_Error Category ID.
*/
- function wp_newCategory($args) {
+ public function wp_newCategory($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$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.
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;
* @since 2.5.0
*
* @param array $args Method parameters.
- * @return mixed See {@link wp_delete_term()} for return info.
+ * @return bool|IXR_Error See {@link wp_delete_term()} for return info.
*/
- function wp_deleteCategory($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];
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;
}
* @since 2.2.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function wp_suggestCategories($args) {
+ public function wp_suggestCategories($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$category = $args[3];
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);
);
}
- return($category_suggestions);
+ return $category_suggestions;
}
/**
* @since 2.7.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function wp_getComment($args) {
+ public function wp_getComment($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$comment_id = (int) $args[3];
if ( !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.' ) );
/**
* 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'.
* @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
+ * @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) {
+ 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();
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'];
* @since 2.7.0
*
* @param array $args Method parameters. Contains:
- * - blog_id
+ * - blog_id (unused)
* - username
* - password
* - comment_id
- * @return mixed {@link wp_delete_comment()}
+ * @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];
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 ( true == $status ) {
+ /**
+ * Fires after a comment has been successfully deleted via XML-RPC.
+ *
+ * @since 3.4.0
+ *
+ * @param int $comment_ID ID of the deleted comment.
+ * @param array $args An array of arguments to delete the comment.
+ */
do_action( 'xmlrpc_call_success_wp_deleteComment', $comment_ID, $args );
+ }
return $status;
}
/**
* 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:
*
* @since 2.7.0
*
- * @param array $args. Contains:
- * - blog_id
+ * @param array $args Contains:
+ * - blog_id (unused)
* - username
* - password
* - comment_id
* - content_struct
- * @return bool True, on success.
+ * @return bool|IXR_Error True, on success.
*/
- function wp_editComment($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];
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();
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;
* @since 2.7.0
*
* @param array $args Method parameters.
- * @return mixed {@link wp_new_comment()}
+ * @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];
$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;
}
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'] = '';
$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;
* @since 2.7.0
*
* @param array $args Method parameters.
- * @return array
+ * @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];
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();
}
* @since 2.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function wp_getCommentCount( $args ) {
+ public function wp_getCommentCount( $args ) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$post_id = (int) $args[3];
if ( !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(
* @since 2.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @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];
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();
}
* @since 2.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @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];
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();
}
* @since 2.6.0
*
* @param array $args Method parameters.
- * @return array
+ * @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];
* @since 2.6.0
*
* @param array $args Method parameters.
- * @return array
+ * @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();
* @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];
$data[$option]['value'] = get_option( $data[$option]['option'] );
unset($data[$option]['option']);
}
+
+ if ( ! $can_manage )
+ $data[$option]['readonly'] = true;
}
}
* @since 2.6.0
*
* @param array $args Method parameters.
- * @return unknown
+ * @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];
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 ) )
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
* @since 3.1.0
*
* @param array $args Method parameters. Contains:
- * - blog_id
+ * - blog_id (unused)
* - username
* - password
* - attachment_id
- * @return array. Associative array containing:
+ * @return array|IXR_Error Associative array contains:
* - 'date_created_gmt'
* - 'parent'
* - 'link'
* - 'description'
* - 'metadata'
*/
- function wp_getMediaItem($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];
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.' ) );
/**
* 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'.
* @since 3.1.0
*
* @param array $args Method parameters. Contains:
- * - blog_id
+ * - blog_id (unused)
* - 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
+ * @return array|IXR_Error Contains a collection of media items. See {@link 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() ;
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'] : '' ;
/**
* Retrieves a list of post formats used by the site
*
- * @since 3.1
+ * @since 3.1.0
*
* @param array $args Method parameters. Contains:
- * - blog_id
+ * - blog_id (unused)
* - username
* - password
- * @return array
+ * @return array|IXR_Error
*/
- function wp_getPostFormats( $args ) {
+ public function wp_getPostFormats( $args ) {
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
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];
*
* @uses get_post_type_object()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - string $post_type_name
* - array $fields
- * @return array contains:
+ * @return array|IXR_Error Array contains:
* - 'labels'
* - 'description'
* - 'capability_type'
* - '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 ) )
*
* @uses get_post_types()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - array $filter
* - array $fields
- * @return array
+ * @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 );
- 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' );
return $struct;
}
+ /**
+ * Retrieve revisions for a specific post.
+ *
+ * @since 3.5.0
+ *
+ * The optional $fields parameter specifies what fields will be included
+ * in the response array.
+ *
+ * @uses wp_get_post_revisions()
+ * @see wp_getPost() for more on $fields
+ *
+ * @param array $args Method parameters. Contains:
+ * - int $blog_id (unused)
+ * - string $username
+ * - string $password
+ * - int $post_id
+ * - array $fields
+ * @return array|IXR_Error contains a collection of posts.
+ */
+ public function wp_getRevisions( $args ) {
+ if ( ! $this->minimum_args( $args, 4 ) )
+ return $this->error;
+
+ $this->escape( $args );
+
+ $username = $args[1];
+ $password = $args[2];
+ $post_id = (int) $args[3];
+
+ if ( isset( $args[4] ) ) {
+ $fields = $args[4];
+ } else {
+ /**
+ * 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' ) );
+
+ if ( ! current_user_can( 'edit_post', $post_id ) )
+ return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts.' ) );
+
+ // Check if revisions are enabled.
+ if ( ! wp_revisions_enabled( $post ) )
+ return new IXR_Error( 401, __( 'Sorry, revisions are disabled.' ) );
+
+ $revisions = wp_get_post_revisions( $post_id );
+
+ if ( ! $revisions )
+ return array();
+
+ $struct = array();
+
+ foreach ( $revisions as $revision ) {
+ if ( ! current_user_can( 'read_post', $revision->ID ) )
+ continue;
+
+ // Skip autosaves
+ if ( wp_is_post_autosave( $revision ) )
+ continue;
+
+ $struct[] = $this->_prepare_post( get_object_vars( $revision ), $fields );
+ }
+
+ return $struct;
+ }
+
+ /**
+ * Restore a post revision
+ *
+ * @since 3.5.0
+ *
+ * @uses wp_restore_post_revision()
+ *
+ * @param array $args Method parameters. Contains:
+ * - int $blog_id (unused)
+ * - string $username
+ * - string $password
+ * - int $post_id
+ * @return bool|IXR_Error false if there was an error restoring, true if success.
+ */
+ public function wp_restoreRevision( $args ) {
+ if ( ! $this->minimum_args( $args, 3 ) )
+ return $this->error;
+
+ $this->escape( $args );
+
+ $username = $args[1];
+ $password = $args[2];
+ $revision_id = (int) $args[3];
+
+ if ( ! $user = $this->login( $username, $password ) )
+ return $this->error;
+
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'wp.restoreRevision' );
+
+ if ( ! $revision = wp_get_post_revision( $revision_id ) )
+ return new IXR_Error( 404, __( 'Invalid post ID' ) );
+
+ if ( wp_is_post_autosave( $revision ) )
+ return new IXR_Error( 404, __( 'Invalid post ID' ) );
+
+ if ( ! $post = get_post( $revision->post_parent ) )
+ return new IXR_Error( 404, __( 'Invalid post ID' ) );
+
+ if ( ! current_user_can( 'edit_post', $revision->post_parent ) )
+ return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
+
+ // Check if revisions are disabled.
+ if ( ! wp_revisions_enabled( $post ) )
+ return new IXR_Error( 401, __( 'Sorry, revisions are disabled.' ) );
+
+ $post = wp_restore_post_revision( $revision_id );
+
+ return (bool) $post;
+ }
+
/* Blogger API functions.
* specs on http://plant.blogger.com/api and http://groups.yahoo.com/group/bloggerDev/
*/
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function blogger_getUsersBlogs($args) {
+ public function blogger_getUsersBlogs($args) {
if ( is_multisite() )
return $this->_multisite_getUsersBlogs($args);
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');
'url' => get_option('home') . '/',
'blogid' => '1',
'blogName' => get_option('blogname'),
- 'xmlrpc' => site_url( 'xmlrpc.php' )
+ 'xmlrpc' => site_url( 'xmlrpc.php', 'rpc' ),
);
return array($struct);
* Private function for retrieving a users blogs for multisite setups
*
* @access protected
+ *
+ * @return array|IXR_Error
*/
- function _multisite_getUsersBlogs($args) {
- global $current_blog;
+ protected function _multisite_getUsersBlogs($args) {
+ $current_blog = get_blog_details();
+
$domain = $current_blog->domain;
$path = $current_blog->path . 'xmlrpc.php';
- $protocol = is_ssl() ? 'https' : 'http';
- $rpc = new IXR_Client("$protocol://{$domain}{$path}");
+ $rpc = new IXR_Client( set_url_scheme( "http://{$domain}{$path}" ) );
$rpc->query('wp.getUsersBlogs', $args[1], $args[2]);
$blogs = $rpc->getResponse();
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function blogger_getUserInfo($args) {
+ public function blogger_getUserInfo($args) {
$this->escape($args);
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,
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function blogger_getPost($args) {
+ public function blogger_getPost($args) {
$this->escape($args);
if ( !$user = $this->login($username, $password) )
return $this->error;
- $post_data = wp_get_single_post($post_ID, ARRAY_A);
+ $post_data = get_post($post_ID, ARRAY_A);
if ( ! $post_data )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( !current_user_can( 'edit_post', $post_ID ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
- 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 = '<title>'.stripslashes($post_data['post_title']).'</title>';
+ $content = '<title>'.wp_unslash($post_data['post_title']).'</title>';
$content .= '<category>'.$categories.'</category>';
- $content .= stripslashes($post_data['post_content']);
+ $content .= wp_unslash($post_data['post_content']);
$struct = array(
'userid' => $post_data['post_author'],
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @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];
if ( isset( $args[4] ) )
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 );
return $this->error;
}
+ $recent_posts = array();
foreach ($posts_list as $entry) {
if ( !current_user_can( 'edit_post', $entry['ID'] ) )
continue;
$post_date = $this->_convert_date( $entry['post_date'] );
$categories = implode(',', wp_get_post_categories($entry['ID']));
- $content = '<title>'.stripslashes($entry['post_title']).'</title>';
+ $content = '<title>'.wp_unslash($entry['post_title']).'</title>';
$content .= '<category>'.$categories.'</category>';
- $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; $j<count($struct); $j++ ) {
- array_push($recent_posts, $struct[$j]);
}
return $recent_posts;
}
/**
- * Retrieve blog_filename content.
+ * Deprecated.
*
* @since 1.5.0
- *
- * @param array $args Method parameters.
- * @return string
+ * @deprecated 3.5.0
+ * @return IXR_Error
*/
- function blogger_getTemplate($args) {
-
- $this->escape($args);
-
- $blog_ID = (int) $args[1];
- $username = $args[2];
- $password = $args[3];
- $template = $args[4]; /* could be 'main' or 'archiveIndex', but we don't use it */
-
- if ( !$user = $this->login($username, $password) )
- return $this->error;
-
- do_action('xmlrpc_call', 'blogger.getTemplate');
-
- if ( !current_user_can('edit_themes') )
- return new IXR_Error(401, __('Sorry, this user cannot edit the template.'));
-
- /* warning: here we make the assumption that the blog's URL is on the same server */
- $filename = get_option('home') . '/';
- $filename = preg_replace('#https?://.+?/#', $_SERVER['DOCUMENT_ROOT'].'/', $filename);
-
- $f = fopen($filename, 'r');
- $content = fread($f, filesize($filename));
- fclose($f);
-
- /* so it is actually editable with a windows/mac client */
- // FIXME: (or delete me) do we really want to cater to bad clients at the expense of good ones by BEEPing up their line breaks? commented. $content = str_replace("\n", "\r\n", $content);
-
- return $content;
+ public function blogger_getTemplate($args) {
+ return new IXR_Error( 403, __('Sorry, that file cannot be edited.' ) );
}
/**
- * Updates the content of blog_filename.
+ * Deprecated.
*
* @since 1.5.0
- *
- * @param array $args Method parameters.
- * @return bool True when done.
+ * @deprecated 3.5.0
+ * @return IXR_Error
*/
- function blogger_setTemplate($args) {
-
- $this->escape($args);
-
- $blog_ID = (int) $args[1];
- $username = $args[2];
- $password = $args[3];
- $content = $args[4];
- $template = $args[5]; /* could be 'main' or 'archiveIndex', but we don't use it */
-
- if ( !$user = $this->login($username, $password) )
- return $this->error;
-
- do_action('xmlrpc_call', 'blogger.setTemplate');
-
- if ( !current_user_can('edit_themes') )
- return new IXR_Error(401, __('Sorry, this user cannot edit the template.'));
-
- /* warning: here we make the assumption that the blog's URL is on the same server */
- $filename = get_option('home') . '/';
- $filename = preg_replace('#https?://.+?/#', $_SERVER['DOCUMENT_ROOT'].'/', $filename);
-
- if ($f = fopen($filename, 'w+')) {
- fwrite($f, $content);
- fclose($f);
- } else {
- return new IXR_Error(500, __('Either the file is not writable, or something wrong happened. The file has not been updated.'));
- }
-
- return true;
+ public function blogger_setTemplate($args) {
+ return new IXR_Error( 403, __('Sorry, that file cannot be edited.' ) );
}
/**
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return int
+ * @return int|IXR_Error
*/
- function blogger_newPost($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];
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($cap) )
+ if ( ! current_user_can( get_post_type_object( 'post' )->cap->create_posts ) || !current_user_can($cap) )
return new IXR_Error(401, __('Sorry, you are not allowed to post on this site.'));
$post_status = ($publish) ? 'publish' : 'draft';
$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 ) )
$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;
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return bool true when done.
+ * @return bool|IXR_Error true when done.
*/
- function blogger_editPost($args) {
+ public function blogger_editPost( $args ) {
$this->escape($args);
$username = $args[2];
$password = $args[3];
$content = $args[4];
- $publish = $args[5];
- 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 = wp_get_single_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;
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return bool True when post is deleted.
+ * @return bool|IXR_Error True when post is deleted.
*/
- function blogger_deletePost($args) {
+ public function blogger_deletePost($args) {
$this->escape($args);
$post_ID = (int) $args[1];
$username = $args[2];
$password = $args[3];
- $publish = $args[4];
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 = wp_get_single_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 ( !$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;
* @since 1.5.0
*
* @param array $args Method parameters. Contains:
- * - blog_id
+ * - blog_id (unused)
* - username
* - password
* - content_struct
* - publish
- * @return int
+ * @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];
$content_struct = $args[3];
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'] ) ) {
$post_type = 'post';
}
+ if ( ! current_user_can( get_post_type_object( $post_type )->cap->create_posts ) )
+ return new IXR_Error( 401, __( 'Sorry, you are not allowed to publish posts on this site.' ) );
if ( !current_user_can( $cap ) )
return new IXR_Error( 401, $error_message );
$post_author = $user->ID;
// If an author id was provided then use it instead.
- if ( isset($content_struct['wp_author_id']) && ($user->ID != $content_struct['wp_author_id']) ) {
+ 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 post as this user')));
+ if ( !current_user_can( 'edit_others_posts' ) )
+ 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')));
+ if ( !current_user_can( 'edit_others_pages' ) )
+ 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 )
// 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']) )
// Handle post formats if assigned, value is validated earlier
// in this function
if ( isset( $content_struct['wp_post_format'] ) )
- wp_set_post_terms( $post_ID, array( 'post-format-' . $content_struct['wp_post_format'] ), 'post_format' );
+ set_post_format( $post_ID, $content_struct['wp_post_format'] );
$post_ID = wp_insert_post( $postdata, true );
if ( is_wp_error( $post_ID ) )
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 );
}
}
* @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) );
}
}
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return bool True on success.
+ * @return bool|IXR_Error True on success.
*/
- function mw_editPost($args) {
+ public function mw_editPost($args) {
$this->escape($args);
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 = wp_get_single_post( $post_ID, ARRAY_A );
+ $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
}
$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'];
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']) ) {
$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 )
// 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']) )
// Handle post formats if assigned, validation is handled
// earlier in this function
if ( isset( $content_struct['wp_post_format'] ) )
- wp_set_post_terms( $post_ID, array( 'post-format-' . $content_struct['wp_post_format'] ), '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;
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function mw_getPost($args) {
+ public function mw_getPost($args) {
$this->escape($args);
if ( !$user = $this->login($username, $password) )
return $this->error;
- $postdata = wp_get_single_post($post_ID, ARRAY_A);
+ $postdata = get_post($post_ID, ARRAY_A);
if ( ! $postdata )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( !current_user_can( 'edit_post', $post_ID ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
- 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'] );
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function mw_getRecentPosts($args) {
+ public function mw_getRecentPosts($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
$username = $args[1];
$password = $args[2];
if ( isset( $args[3] ) )
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();
+ $recent_posts = array();
foreach ($posts_list as $entry) {
if ( !current_user_can( 'edit_post', $entry['ID'] ) )
continue;
if ( empty( $post_format ) )
$post_format = 'standard';
- $struct[] = array(
+ $recent_posts[] = array(
'dateCreated' => $post_date,
'userid' => $entry['post_author'],
'postid' => (string) $entry['ID'],
'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; $j<count($struct); $j++ ) {
- array_push($recent_posts, $struct[$j]);
}
return $recent_posts;
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function mw_getCategories($args) {
+ public function mw_getCategories($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
$username = $args[1];
$password = $args[2];
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;
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @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]);
+ $username = $this->escape($args[1]);
+ $password = $this->escape($args[2]);
$data = $args[3];
$name = sanitize_file_name( $data['name'] );
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.
return new IXR_Error(500, $errorString);
}
// Construct the attachment array
- // attach to post_id 0
$post_id = 0;
+ if ( ! empty( $data['post_id'] ) ) {
+ $post_id = (int) $data['post_id'];
+
+ if ( ! current_user_can( 'edit_post', $post_id ) )
+ return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
+ }
$attachment = array(
'post_title' => $name,
'post_content' => '',
$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(
'url' => $upload[ 'url' ],
'type' => $type
);
+
+ /** This filter is documented in wp-admin/includes/file.php */
return apply_filters( 'wp_handle_upload', $struct, 'upload' );
}
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function mt_getRecentPostTitles($args) {
+ public function mt_getRecentPostTitles($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
$username = $args[1];
$password = $args[2];
if ( isset( $args[3] ) )
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 );
return $this->error;
}
- $struct = array();
+ $recent_posts = array();
foreach ($posts_list as $entry) {
if ( !current_user_can( 'edit_post', $entry['ID'] ) )
$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'],
'post_status' => $entry['post_status'],
'date_created_gmt' => $post_date_gmt
);
-
- }
-
- $recent_posts = array();
- for ( $j=0; $j<count($struct); $j++ ) {
- array_push($recent_posts, $struct[$j]);
}
return $recent_posts;
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function mt_getCategoryList($args) {
+ public function mt_getCategoryList($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
$username = $args[1];
$password = $args[2];
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;
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function mt_getPostCategories($args) {
+ public function mt_getPostCategories($args) {
$this->escape($args);
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));
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return bool True on success.
+ * @return bool|IXR_Error True on success.
*/
- function mt_setPostCategories($args) {
+ public function mt_setPostCategories($args) {
$this->escape($args);
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.' ) );
if ( !current_user_can('edit_post', $post_ID) )
return new IXR_Error(401, __('Sorry, you cannot edit this post.'));
+ $catids = array();
foreach ( $categories as $cat ) {
$catids[] = $cat['categoryId'];
}
* @param array $args Method parameters.
* @return array
*/
- function mt_supportedMethods($args) {
+ public function mt_supportedMethods($args) {
- do_action('xmlrpc_call', 'mt.supportedMethods');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'mt.supportedMethods' );
$supported_methods = array();
foreach ( $this->methods as $key => $value ) {
*
* @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($args) {
+ /** 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() );
}
/**
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return mixed
+ * @return array|IXR_Error
*/
- function mt_getTrackbackPings($args) {
+ public function mt_getTrackbackPings($args) {
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 = wp_get_single_post($post_ID, ARRAY_A);
+ $actual_post = get_post($post_ID, ARRAY_A);
if ( !$actual_post )
return new IXR_Error(404, __('Sorry, no such post.'));
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return int
+ * @return int|IXR_Error
*/
- function mt_publishPost($args) {
+ public function mt_publishPost($args) {
$this->escape($args);
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 = wp_get_single_post($post_ID, ARRAY_A);
+ $postdata = get_post($post_ID, ARRAY_A);
if ( ! $postdata )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return string|IXR_Error
*/
- function pingback_ping($args) {
+ public function pingback_ping($args) {
global $wpdb;
- do_action('xmlrpc_call', 'pingback.ping');
+ /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
+ do_action( 'xmlrpc_call', 'pingback.ping' );
$this->escape($args);
$pagelinkedfrom = $args[0];
$pagelinkedto = $args[1];
- $title = '';
-
$pagelinkedfrom = str_replace('&', '&', $pagelinkedfrom);
$pagelinkedto = str_replace('&', '&', $pagelinkedto);
$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.' ) );
+
// Check if the page linked to is in our site
$pos1 = strpos($pagelinkedto, str_replace(array('http://www.','http://','https://www.','https://'), '', get_option('home')));
if ( !$pos1 )
- return new IXR_Error(0, __('Is there no link to us?'));
+ return $this->pingback_error( 0, __( 'Is there no link to us?' ) );
// let's find which post is linked to
// FIXME: does url_to_postid() cover all these cases already?
// 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 ( preg_match('#p=[0-9]{1,}#', $urltest['query'], $match) ) {
+ } 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 new IXR_Error(0, '');
+ return $this->pingback_error( 0, '' );
}
- $way = 'from the fragment (title)';
}
} else {
// TODO: Attempt to extract a post ID from the given URL
- return new IXR_Error(33, __('The specified target URL cannot be used as a target. It either doesn’t exist, or it is not a pingback-enabled resource.'));
+ return $this->pingback_error( 33, __('The specified target URL cannot be used as a target. It either doesn’t exist, or it is not a pingback-enabled resource.' ) );
}
$post_ID = (int) $post_ID;
$post = get_post($post_ID);
if ( !$post ) // Post_ID not found
- return new IXR_Error(33, __('The specified target URL cannot be used as a target. It either doesn’t exist, or it is not a pingback-enabled resource.'));
+ return $this->pingback_error( 33, __( 'The specified target URL cannot be used as a target. It either doesn’t exist, or it is not a pingback-enabled resource.' ) );
if ( $post_ID == url_to_postid($pagelinkedfrom) )
- return new IXR_Error(0, __('The source URL and the target URL cannot both point to the same resource.'));
+ return $this->pingback_error( 0, __( 'The source URL and the target URL cannot both point to the same resource.' ) );
// Check if pings are on
if ( !pings_open($post) )
- return new IXR_Error(33, __('The specified target URL cannot be used as a target. It either doesn’t exist, or it is not a pingback-enabled resource.'));
+ return $this->pingback_error( 33, __( 'The specified target URL cannot be used as a target. It either doesn’t exist, or it is not a pingback-enabled resource.' ) );
// Let's check that the remote site didn't already pingback this entry
if ( $wpdb->get_results( $wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_author_url = %s", $post_ID, $pagelinkedfrom) ) )
- return new IXR_Error( 48, __( 'The pingback has already been registered.' ) );
+ return $this->pingback_error( 48, __( 'The pingback has already been registered.' ) );
// 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/' . $GLOBALS['wp_version'] . '; ' . get_bloginfo( 'url' ) );
+
// Let's check the remote site
- $linea = wp_remote_fopen( $pagelinkedfrom );
- if ( !$linea )
- return new IXR_Error(16, __('The source URL does not exist.'));
+ $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 );
- $linea = apply_filters('pre_remote_source', $linea, $pagelinkedto);
+ if ( !$linea )
+ 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('<!DOC', '<DOC', $linea);
- $linea = preg_replace( '/[\s\r\n\t]+/', ' ', $linea ); // normalize spaces
- $linea = preg_replace( "/ <(h1|h2|h3|h4|h5|h6|p|th|td|li|dt|dd|pre|caption|input|textarea|button|body)[^>]*>/", "\n\n", $linea );
+ $linea = preg_replace( '/[\r\n\t ]+/', ' ', $linea ); // normalize spaces
+ $linea = preg_replace( "/<\/*(h1|h2|h3|h4|h5|h6|p|th|td|li|dt|dd|pre|caption|input|textarea|button|body)[^>]*>/", "\n\n", $linea );
preg_match('|<title>([^<]*?)</title>|is', $linea, $matchtitle);
$title = $matchtitle[1];
if ( empty( $title ) )
- return new IXR_Error(32, __('We cannot find a title on that page.'));
+ return $this->pingback_error( 32, __('We cannot find a title on that page.' ) );
$linea = strip_tags( $linea, '<a>' ); // just keep the tag we need
// 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 = '<wpcontext>'.$context[1].'</wpcontext>'; // set up our marker
$excerpt= str_replace($context[0], $marker, $excerpt); // swap out the link for our marker
}
if ( empty($context) ) // Link to target not found
- return new IXR_Error(17, __('The source URL does not contain a link to the target URL, and so cannot be used as a source.'));
+ return $this->pingback_error( 17, __( 'The source URL does not contain a link to the target URL, and so cannot be used as a source.' ) );
$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;
$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);
}
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
- function pingback_extensions_getPingbacks($args) {
+ public function pingback_extensions_getPingbacks($args) {
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);
$post_ID = url_to_postid($url);
if ( !$post_ID ) {
// We aren't sure that the resource is available and/or pingback enabled
- return new IXR_Error(33, __('The specified target URL cannot be used as a target. It either doesn’t exist, or it is not a pingback-enabled resource.'));
+ return $this->pingback_error( 33, __( 'The specified target URL cannot be used as a target. It either doesn’t exist, or it is not a pingback-enabled resource.' ) );
}
- $actual_post = wp_get_single_post($post_ID, ARRAY_A);
+ $actual_post = get_post($post_ID, ARRAY_A);
if ( !$actual_post ) {
// No such post = resource not found
- return new IXR_Error(32, __('The specified target URL does not exist.'));
+ return $this->pingback_error( 32, __('The specified target URL does not exist.' ) );
}
$comments = $wpdb->get_results( $wpdb->prepare("SELECT comment_author_url, comment_content, comment_author_IP, comment_type FROM $wpdb->comments WHERE comment_post_ID = %d", $post_ID) );
return $pingbacks;
}
+
+ /**
+ * @param integer $code
+ * @param string $message
+ */
+ 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 ) );
+ }
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff