* @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.
*
*
* @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
*/
public function login( $username, $password ) {
/*
* @param array $args Method parameters. Contains:
* - username
* - password
- * @return array. Contains:
+ * @return array|IXR_Error Array contains:
* - 'isAdmin'
* - 'url'
* - 'blogid'
// 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.
*/
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,
* @since 3.4.0
*
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - array $content_struct
* - 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
*/
public function wp_newPost( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$content_struct = $args[3];
* @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,
* @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
*/
public function wp_editPost( $args ) {
if ( ! $this->minimum_args( $args, 5 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$post_id = (int) $args[3];
*
* @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
*/
public function wp_deletePost( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$post_id = (int) $args[3];
*
* @uses get_post()
* @param array $args Method parameters. Contains:
- * - int $post_id
+ * - int $blog_id (unset)
* - 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'
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$post_id = (int) $args[3];
* @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.
*/
public function wp_getPosts( $args ) {
if ( ! $this->minimum_args( $args, 3 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$filter = isset( $args[3] ) ? $args[3] : array();
*
* @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
*/
public function wp_newTerm( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$content_struct = $args[3];
*
* @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.
*/
public function wp_editTerm( $args ) {
if ( ! $this->minimum_args( $args, 5 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$term_id = (int) $args[3];
*
* @uses wp_delete_term()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - string $taxnomy_name
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$taxonomy = $args[3];
*
* @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'
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$taxonomy = $args[3];
*
* @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
*/
public function wp_getTerms( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$taxonomy = $args[3];
*
* @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())
*/
public function wp_getTaxonomy( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$taxonomy = $args[3];
*
* @uses get_taxonomies()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* @return array taxonomies
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$filter = isset( $args[3] ) ? $args[3] : array( 'public' => true );
*
* @uses get_userdata()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - int $user_id
* - array $fields optional
- * @return array contains (based on $fields parameter):
+ * @return array|IXR_Error Array contains (based on $fields parameter):
* - 'user_id'
* - 'username'
* - 'first_name'
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$user_id = (int) $args[3];
* @see wp_getUser() for more on $fields and return 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 users data
+ * @return array|IXR_Error users data
*/
public function wp_getUsers( $args ) {
if ( ! $this->minimum_args( $args, 3 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$filter = isset( $args[3] ) ? $args[3] : array();
*
* @uses get_userdata()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - array $fields optional
- * @return array (@see wp_getUser)
+ * @return array|IXR_Error (@see wp_getUser)
*/
public function wp_getProfile( $args ) {
if ( ! $this->minimum_args( $args, 3 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
*
* @uses wp_update_user()
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - array $content_struct
* - 'nickname'
* - 'nicename'
* - 'bio'
- * @return bool True, on success.
+ * @return bool|IXR_Error True, on success.
*/
public function wp_editProfile( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$content_struct = $args[3];
* @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
*/
public function wp_getPage($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$page_id = (int) $args[1];
$username = $args[2];
$password = $args[3];
* @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
*/
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;
$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
*/
public function wp_newPage($args) {
// Items not escaped here will be escaped in newPost.
$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.
*/
public function wp_deletePage($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$page_id = (int) $args[3];
// make sure it is a page and not a post.
$actual_page = get_post($page_id, ARRAY_A);
if ( !$actual_page || ($actual_page['post_type'] != 'page') )
- return(new IXR_Error(404, __('Sorry, no such page.')));
+ return new IXR_Error( 404, __( 'Sorry, no such page.' ) );
// Make sure the user can delete pages.
if ( !current_user_can('delete_page', $page_id) )
- return(new IXR_Error(401, __('Sorry, you do not have the right to delete this page.')));
+ return new IXR_Error( 401, __( 'Sorry, you do not have the right to delete this page.' ) );
// Attempt to delete the page.
$result = wp_delete_post($page_id);
if ( !$result )
- return(new IXR_Error(500, __('Failed to delete the page.')));
+ return new IXR_Error( 500, __( 'Failed to delete the page.' ) );
/**
* Fires after a page has been successfully deleted via XML-RPC.
*/
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
*/
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]);
// Get the page data and make sure it is a page.
$actual_page = get_post($page_id, ARRAY_A);
if ( !$actual_page || ($actual_page['post_type'] != 'page') )
- return(new IXR_Error(404, __('Sorry, no such page.')));
+ return new IXR_Error( 404, __( 'Sorry, no such page.' ) );
// Make sure the user is allowed to edit pages.
if ( !current_user_can('edit_page', $page_id) )
- return(new IXR_Error(401, __('Sorry, you do not have the right to edit this page.')));
+ return new IXR_Error( 401, __( 'Sorry, you do not have the right to edit this page.' ) );
// Mark this as content for a page.
$content['post_type'] = 'page';
);
// 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
*/
public function wp_getPageList($args) {
global $wpdb;
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
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
*/
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.' ) );
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getAuthors' );
* @since 2.7.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function wp_getTags( $args ) {
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
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.
*/
public function wp_newCategory($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$category = $args[3];
// 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.'));
}
/**
* @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.
*/
public function wp_deleteCategory($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$category_id = (int) $args[3];
* @since 2.2.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function wp_suggestCategories($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$category = $args[3];
);
}
- return($category_suggestions);
+ return $category_suggestions;
}
/**
* @since 2.7.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function wp_getComment($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$comment_id = (int) $args[3];
/**
* 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
*/
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();
* @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()}
*/
public function wp_deleteComment($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$comment_ID = (int) $args[3];
/**
* 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
+ * - blog_id (unused)
* - username
* - password
* - comment_id
* - content_struct
- * @return bool True, on success.
+ * @return bool|IXR_Error True, on success.
*/
public function wp_editComment($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$comment_ID = (int) $args[3];
* @since 2.7.0
*
* @param array $args Method parameters.
- * @return mixed {@link wp_new_comment()}
+ * @return int|IXR_Error {@link wp_new_comment()}
*/
public function wp_newComment($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$post = $args[3];
if ( ! get_post($post_id) )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
+ $comment = array();
$comment['comment_post_ID'] = $post_id;
if ( $logged_in ) {
* @since 2.7.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function wp_getCommentStatusList($args) {
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
* @since 2.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function wp_getCommentCount( $args ) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$post_id = (int) $args[3];
* @since 2.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function wp_getPostStatusList( $args ) {
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
* @since 2.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function wp_getPageStatusList( $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
*/
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
*/
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();
* @since 2.6.0
*
* @param array $args Method parameters.
- * @return unknown
+ * @return array|IXR_Error
*/
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 ) )
* @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'
public function wp_getMediaItem($args) {
$this->escape($args);
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$attachment_id = (int) $args[3];
/**
* 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
*/
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() ;
* @since 3.1.0
*
* @param array $args Method parameters. Contains:
- * - blog_id
+ * - blog_id (unused)
* - username
* - password
- * @return array
+ * @return array|IXR_Error
*/
public function wp_getPostFormats( $args ) {
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
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'
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$post_type_name = $args[3];
*
* @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
*/
public function wp_getPostTypes( $args ) {
if ( ! $this->minimum_args( $args, 3 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$filter = isset( $args[3] ) ? $args[3] : array( 'public' => true );
* @see wp_getPost() for more on $fields
*
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - int $post_id
* - array $fields
- * @return array contains a collection of posts.
+ * @return array|IXR_Error contains a collection of posts.
*/
public function wp_getRevisions( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$post_id = (int) $args[3];
* @uses wp_restore_post_revision()
*
* @param array $args Method parameters. Contains:
- * - int $blog_id
+ * - int $blog_id (unused)
* - string $username
* - string $password
* - int $post_id
- * @return bool false if there was an error restoring, true if success.
+ * @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 ) )
$this->escape( $args );
- $blog_id = (int) $args[0];
$username = $args[1];
$password = $args[2];
$revision_id = (int) $args[3];
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function blogger_getUsersBlogs($args) {
if ( is_multisite() )
* Private function for retrieving a users blogs for multisite setups
*
* @access protected
+ *
+ * @return array|IXR_Error
*/
protected function _multisite_getUsersBlogs($args) {
$current_blog = get_blog_details();
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function blogger_getUserInfo($args) {
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function blogger_getPost($args) {
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
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] ) )
return $this->error;
}
+ $recent_posts = array();
foreach ($posts_list as $entry) {
if ( !current_user_can( 'edit_post', $entry['ID'] ) )
continue;
$content .= '<category>'.$categories.'</category>';
$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;
*
* @since 1.5.0
* @deprecated 3.5.0
+ * @return IXR_Error
*/
public function blogger_getTemplate($args) {
return new IXR_Error( 403, __('Sorry, that file cannot be edited.' ) );
*
* @since 1.5.0
* @deprecated 3.5.0
+ * @return IXR_Error
*/
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
*/
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];
$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 ) )
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return bool true when done.
+ * @return bool|IXR_Error true when done.
*/
public function blogger_editPost( $args ) {
* @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.
*/
public function blogger_deletePost($args) {
$this->escape($args);
* @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
*/
public function mw_newPost($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
$username = $args[1];
$password = $args[2];
$content_struct = $args[3];
switch ( $post_type ) {
case "post":
if ( !current_user_can( 'edit_others_posts' ) )
- return( new IXR_Error( 401, __( 'You are not allowed to create posts as this user.' ) ) );
+ return new IXR_Error( 401, __( 'You are not allowed to create posts as this user.' ) );
break;
case "page":
if ( !current_user_can( 'edit_others_pages' ) )
- return( new IXR_Error( 401, __( 'You are not allowed to create pages as this user.' ) ) );
+ return new IXR_Error( 401, __( 'You are not allowed to create pages as this user.' ) );
break;
default:
- return( new IXR_Error( 401, __( 'Invalid post type' ) ) );
+ return new IXR_Error( 401, __( 'Invalid post type' ) );
break;
}
$author = get_userdata( $content_struct['wp_author_id'] );
return strval($post_ID);
}
+ /**
+ * @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'] . "\n";
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return bool True on success.
+ * @return bool|IXR_Error True on success.
*/
public function mw_editPost($args) {
switch ( $post_type ) {
case 'post':
if ( !current_user_can('edit_others_posts') )
- return(new IXR_Error(401, __('You are not allowed to change the post author as this user.')));
+ return new IXR_Error( 401, __( 'You are not allowed to change the post author as this user.' ) );
break;
case 'page':
if ( !current_user_can('edit_others_pages') )
- return(new IXR_Error(401, __('You are not allowed to change the page author as this user.')));
+ return new IXR_Error( 401, __( 'You are not allowed to change the page author as this user.' ) );
break;
default:
- return(new IXR_Error(401, __('Invalid post type')));
+ return new IXR_Error( 401, __( 'Invalid post type' ) );
break;
}
$post_author = $content_struct['wp_author_id'];
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function mw_getPost($args) {
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function mw_getRecentPosts($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
$username = $args[1];
$password = $args[2];
if ( isset( $args[3] ) )
if ( !$posts_list )
return array();
- $struct = 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'],
'date_modified' => $post_modified,
'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
*/
public function mw_getCategories($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
$username = $args[1];
$password = $args[2];
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
*/
public function mw_newMediaObject($args) {
global $wpdb;
- $blog_ID = (int) $args[0];
$username = $this->escape($args[1]);
$password = $this->escape($args[2]);
$data = $args[3];
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function mt_getRecentPostTitles($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
$username = $args[1];
$password = $args[2];
if ( isset( $args[3] ) )
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
*/
public function mt_getCategoryList($args) {
$this->escape($args);
- $blog_ID = (int) $args[0];
$username = $args[1];
$password = $args[2];
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
*/
public function mt_getPostCategories($args) {
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return bool True on success.
+ * @return bool|IXR_Error True on success.
*/
public function mt_setPostCategories($args) {
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return mixed
+ * @return array|IXR_Error
*/
public function mt_getTrackbackPings($args) {
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return int
+ * @return int|IXR_Error
*/
public function mt_publishPost($args) {
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return string|IXR_Error
*/
public function pingback_ping($args) {
global $wpdb;
// 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()';
+ // $way
} elseif ( isset( $urltest['path'] ) && preg_match('#p/[0-9]{1,}#', $urltest['path'], $match) ) {
// the path defines the post_ID (archives/p/XXXX)
$blah = explode('/', $match[0]);
$post_ID = (int) $blah[1];
- $way = 'from the path';
} elseif ( isset( $urltest['query'] ) && preg_match('#p=[0-9]{1,}#', $urltest['query'], $match) ) {
// the querystring defines the post_ID (?p=XXXX)
$blah = explode('=', $match[0]);
$post_ID = (int) $blah[1];
- $way = 'from the querystring';
} elseif ( isset($urltest['fragment']) ) {
// an #anchor is there, it's either...
if ( intval($urltest['fragment']) ) {
// ...an integer #XXXX (simplest case)
$post_ID = (int) $urltest['fragment'];
- $way = 'from the fragment (numeric)';
} elseif ( preg_match('/post-[0-9]+/',$urltest['fragment']) ) {
// ...a post id in the form 'post-###'
$post_ID = preg_replace('/[^0-9]+/', '', $urltest['fragment']);
- $way = 'from the fragment (post-###)';
} elseif ( is_string($urltest['fragment']) ) {
// ...or a string #title, a little more complicated
$title = preg_replace('/[^a-z0-9]/i', '.', $urltest['fragment']);
// returning unknown error '0' is better than die()ing
return $this->pingback_error( 0, '' );
}
- $way = 'from the fragment (title)';
}
} else {
// TODO: Attempt to extract a post ID from the given URL
* @since 1.5.0
*
* @param array $args Method parameters.
- * @return array
+ * @return array|IXR_Error
*/
public function pingback_extensions_getPingbacks($args) {
return $pingbacks;
}
+ /**
+ * @param integer $code
+ * @param string $message
+ */
protected function pingback_error( $code, $message ) {
/**
* Filter the XML-RPC pingback error return.
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff