*/
class wp_xmlrpc_server extends IXR_Server {
/**
+ * Methods.
+ *
+ * @access public
* @var array
*/
public $methods;
+
/**
+ * Blog options.
+ *
+ * @access public
* @var array
*/
public $blog_options;
+
/**
+ * IXR_Error instance.
+ *
+ * @access public
* @var IXR_Error
*/
public $error;
+
/**
* Register all of the XMLRPC methods that XMLRPC server understands.
*
* or replace XMLRPC methods.
*
* @since 1.5.0
- *
- * @return wp_xmlrpc_server
*/
public function __construct() {
$this->methods = array(
*
* @param callable $name Method to call.
* @param array $arguments Arguments to pass when calling.
- * @return mixed|bool Return value of the callback, false otherwise.
+ * @return array|IXR_Error|false Return value of the callback, false otherwise.
*/
public function __call( $name, $arguments ) {
- return call_user_func_array( array( $this, $name ), $arguments );
+ if ( '_multisite_getUsersBlogs' === $name ) {
+ return call_user_func_array( array( $this, $name ), $arguments );
+ }
+ return false;
}
+ /**
+ * @access public
+ */
public function serve_request() {
$this->IXR_Server($this->methods);
}
*
* @since 1.5.0
*
- * @param array $args Method Parameters.
- * @return string
+ * @return string Hello string response.
*/
- public function sayHello($args) {
+ public function sayHello() {
return 'Hello!';
}
*
* @since 1.5.0
*
- * @param array $args Method Parameters.
- * @return int
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $number1 A number to add.
+ * @type int $number2 A second number to add.
+ * }
+ * @return int Sum of the two given numbers.
*/
- public function addTwoNumbers($args) {
+ public function addTwoNumbers( $args ) {
$number1 = $args[0];
$number2 = $args[1];
return $number1 + $number2;
* @since 1.5.2
*
* @param string|array $data Escape single string or array of strings.
- * @return string|array Type matches $data and sanitized for the database.
+ * @return string|void Returns with string is passed, alters by-reference
+ * when array is passed.
*/
public function escape( &$data ) {
if ( ! is_array( $data ) )
/**
* Set up blog options property.
*
- * Passes property through 'xmlrpc_blog_options' filter.
+ * Passes property through {@see 'xmlrpc_blog_options'} filter.
*
* @since 2.6.0
+ *
+ * @global string $wp_version
*/
public function initialise_blog_option_info() {
global $wp_version;
'option' => 'default_comment_status'
),
'default_ping_status' => array(
- 'desc' => __( 'Allow link notifications from other blogs (pingbacks and trackbacks)' ),
+ 'desc' => __( 'Allow link notifications from other blogs (pingbacks and trackbacks) on new articles' ),
'readonly' => false,
'option' => 'default_ping_status'
)
*
* @since 2.6.0
*
- * @param array $args Method parameters. Contains:
- * - username
- * - password
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type string $username Username.
+ * @type string $password Password.
+ * }
* @return array|IXR_Error Array contains:
* - 'isAdmin'
* - 'url'
*
* @since 2.5.0
*
- * @param method $name The method name.
+ * @param string $name The method name.
*/
do_action( 'xmlrpc_call', 'wp.getUsersBlogs' );
$struct = array();
foreach ( $blogs as $blog ) {
- // Don't include blogs that aren't hosted at this site
+ // Don't include blogs that aren't hosted at this site.
if ( $blog->site_id != get_current_site()->id )
continue;
* Checks if the method received at least the minimum number of arguments.
*
* @since 3.4.0
+ * @access protected
*
* @param string|array $args Sanitize single string or array of strings.
- * @param int $count Minimum number of arguments.
- * @return boolean if $args contains at least $count arguments.
+ * @param int $count Minimum number of arguments.
+ * @return bool if `$args` contains at least $count arguments.
*/
protected function minimum_args( $args, $count ) {
if ( count( $args ) < $count ) {
*
* @access protected
*
- * @param object $taxonomy The unprepared taxonomy data
- * @param array $fields The subset of taxonomy fields to return
- * @return array The prepared taxonomy data
+ * @param object $taxonomy The unprepared taxonomy data.
+ * @param array $fields The subset of taxonomy fields to return.
+ * @return array The prepared taxonomy data.
*/
protected function _prepare_taxonomy( $taxonomy, $fields ) {
$_taxonomy = array(
*
* @access protected
*
- * @param array|object $term The unprepared term data
- * @return array The prepared term data
+ * @param array|object $term The unprepared term data.
+ * @return array The prepared term data.
*/
protected function _prepare_term( $term ) {
$_term = $term;
- if ( ! is_array( $_term) )
+ if ( ! is_array( $_term ) )
$_term = get_object_vars( $_term );
// For integers which may be larger than XML-RPC supports ensure we return strings.
*
* @access protected
*
- * @param string $date
- * @return IXR_Date
+ * @param string $date Date string to convert.
+ * @return IXR_Date IXR_Date object.
*/
protected function _convert_date( $date ) {
if ( $date === '0000-00-00 00:00:00' ) {
*
* @access protected
*
- * @param string $date_gmt
- * @param string $date
- * @return IXR_Date
+ * @param string $date_gmt WordPress GMT date string.
+ * @param string $date Date string.
+ * @return IXR_Date IXR_Date object.
*/
protected function _convert_date_gmt( $date_gmt, $date ) {
if ( $date !== '0000-00-00 00:00:00' && $date_gmt === '0000-00-00 00:00:00' ) {
*
* @access protected
*
- * @param array $post The unprepared post data
- * @param array $fields The subset of post type fields to return
- * @return array The prepared post data
+ * @param array $post The unprepared post data.
+ * @param array $fields The subset of post type fields to return.
+ * @return array The prepared post data.
*/
protected function _prepare_post( $post, $fields ) {
- // holds the data for this post. built up based on $fields
+ // Holds the data for this post. built up based on $fields.
$_post = array( 'post_id' => strval( $post['ID'] ) );
- // prepare common post fields
+ // Prepare common post fields.
$post_fields = array(
'post_title' => $post['post_title'],
'post_date' => $this->_convert_date( $post['post_date'] ),
'sticky' => ( $post['post_type'] === 'post' && is_sticky( $post['ID'] ) ),
);
- // Thumbnail
+ // Thumbnail.
$post_fields['post_thumbnail'] = array();
$thumbnail_id = get_post_thumbnail_id( $post['ID'] );
if ( $thumbnail_id ) {
$post_fields['post_thumbnail'] = $this->_prepare_media_item( get_post( $thumbnail_id ), $thumbnail_size );
}
- // Consider future posts as published
+ // Consider future posts as published.
if ( $post_fields['post_status'] === 'future' )
$post_fields['post_status'] = 'publish';
- // Fill in blank post format
+ // Fill in blank post format.
$post_fields['post_format'] = get_post_format( $post['ID'] );
if ( empty( $post_fields['post_format'] ) )
$post_fields['post_format'] = 'standard';
- // Merge requested $post_fields fields into $_post
+ // Merge requested $post_fields fields into $_post.
if ( in_array( 'post', $fields ) ) {
$_post = array_merge( $_post, $post_fields );
} else {
*
* @access protected
*
- * @param object $post_type Post type object
- * @param array $fields The subset of post fields to return
- * @return array The prepared post type data
+ * @param object $post_type Post type object.
+ * @param array $fields The subset of post fields to return.
+ * @return array The prepared post type data.
*/
protected function _prepare_post_type( $post_type, $fields ) {
$_post_type = array(
*
* @access protected
*
- * @param object $media_item The unprepared media item data
- * @param string $thumbnail_size The image size to use for the thumbnail URL
- * @return array The prepared media item data
+ * @param object $media_item The unprepared media item data.
+ * @param string $thumbnail_size The image size to use for the thumbnail URL.
+ * @return array The prepared media item data.
*/
protected function _prepare_media_item( $media_item, $thumbnail_size = 'thumbnail' ) {
$_media_item = array(
*
* @access protected
*
- * @param object $page The unprepared page data
- * @return array The prepared page data
+ * @param object $page The unprepared page data.
+ * @return array The prepared page data.
*/
protected function _prepare_page( $page ) {
// Get all of the page content and link.
*
* @access protected
*
- * @param object $comment The unprepared comment data
- * @return array The prepared comment data
+ * @param object $comment The unprepared comment data.
+ * @return array The prepared comment data.
*/
protected function _prepare_comment( $comment ) {
// Format page date.
*
* @access protected
*
- * @param WP_User $user The unprepared user object
- * @param array $fields The subset of user fields to return
- * @return array The prepared user data
+ * @param WP_User $user The unprepared user object.
+ * @param array $fields The subset of user fields to return.
+ * @return array The prepared user data.
*/
protected function _prepare_user( $user, $fields ) {
$_user = array( 'user_id' => strval( $user->ID ) );
*
* @since 3.4.0
*
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - array $content_struct
- * $content_struct can contain:
- * - post_type (default: 'post')
- * - post_status (default: 'draft')
- * - post_title
- * - post_author
- * - post_excerpt
- * - post_content
- * - post_date_gmt | post_date
- * - post_format
- * - post_password
- * - comment_status - can be 'open' | 'closed'
- * - ping_status - can be 'open' | 'closed'
- * - sticky
- * - post_thumbnail - ID of a media item to use as the post thumbnail/featured image
- * - custom_fields - array, with each element containing 'key' and 'value'
- * - terms - array, with taxonomy names as keys and arrays of term IDs as values
- * - terms_names - array, with taxonomy names as keys and arrays of term names as values
- * - enclosure
- * - any other fields supported by wp_insert_post()
- * @return string|IXR_Error post_id
+ * @link http://en.wikipedia.org/wiki/RSS_enclosure for information on RSS enclosures.
+ *
+ * @param array $args {
+ * Method arguments. Note: top-level arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type array $content_struct {
+ * Content struct for adding a new post. See wp_insert_post() for information on
+ * additional post fields
+ *
+ * @type string $post_type Post type. Default 'post'.
+ * @type string $post_status Post status. Default 'draft'
+ * @type string $post_title Post title.
+ * @type int $post_author Post author ID.
+ * @type string $post_excerpt Post excerpt.
+ * @type string $post_content Post content.
+ * @type string $post_date_gmt Post date in GMT.
+ * @type string $post_date Post date.
+ * @type string $post_password Post password (20-character limit).
+ * @type string $comment_status Post comment enabled status. Accepts 'open' or 'closed'.
+ * @type string $ping_status Post ping status. Accepts 'open' or 'closed'.
+ * @type bool $sticky Whether the post should be sticky. Automatically false if
+ * `$post_status` is 'private'.
+ * @type int $post_thumbnail ID of an image to use as the post thumbnail/featured image.
+ * @type array $custom_fields Array of meta key/value pairs to add to the post.
+ * @type array $terms Associative array with taxonomy names as keys and arrays
+ * of term IDs as values.
+ * @type array $terms_names Associative array with taxonomy names as keys and arrays
+ * of term names as values.
+ * @type array $enclosure {
+ * Array of feed enclosure data to add to post meta.
+ *
+ * @type string $url URL for the feed enclosure.
+ * @type int $length Size in bytes of the enclosure.
+ * @type string $type Mime-type for the enclosure.
+ * }
+ * }
+ * }
+ * @return int|IXR_Error Post ID on success, IXR_Error instance otherwise.
*/
public function wp_newPost( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
return $this->error;
// convert the date field back to IXR form
- if ( isset( $content_struct['post_date'] ) && ! is_a( $content_struct['post_date'], 'IXR_Date' ) ) {
+ 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'] ) && ! is_a( $content_struct['post_date_gmt'], 'IXR_Date' ) ) {
+ 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 {
}
/**
- * Helper method for wp_newPost and wp_editPost, containing shared logic.
+ * Encapsulate the logic for sticking a post
+ * and determining if the user has permission to do so
+ *
+ * @since 4.3.0
+ * @access private
+ *
+ * @param array $post_data
+ * @param bool $update
+ * @return void|IXR_Error
+ */
+ private function _toggle_sticky( $post_data, $update = false ) {
+ $post_type = get_post_type_object( $post_data['post_type'] );
+
+ // Private and password-protected posts cannot be stickied.
+ if ( 'private' === $post_data['post_status'] || ! empty( $post_data['post_password'] ) ) {
+ // Error if the client tried to stick the post, otherwise, silently unstick.
+ if ( ! empty( $post_data['sticky'] ) ) {
+ return new IXR_Error( 401, __( 'Sorry, you cannot stick a private post.' ) );
+ }
+
+ if ( $update ) {
+ unstick_post( $post_data['ID'] );
+ }
+ } elseif ( isset( $post_data['sticky'] ) ) {
+ if ( ! current_user_can( $post_type->cap->edit_others_posts ) ) {
+ return new IXR_Error( 401, __( 'Sorry, you are not allowed to stick this post.' ) );
+ }
+
+ $sticky = wp_validate_boolean( $post_data['sticky'] );
+ if ( $sticky ) {
+ stick_post( $post_data['ID'] );
+ } else {
+ unstick_post( $post_data['ID'] );
+ }
+ }
+ }
+
+ /**
+ * Helper method for wp_newPost() and wp_editPost(), containing shared logic.
*
* @since 3.4.0
- * @uses wp_insert_post()
+ * @access protected
+ *
+ * @see wp_insert_post()
*
- * @param WP_User $user The post author if post_author isn't set in $content_struct.
+ * @param WP_User $user The post author if post_author isn't set in $content_struct.
* @param array|IXR_Error $content_struct Post data to insert.
+ * @return IXR_Error|string
*/
protected function _insert_post( $user, $content_struct ) {
$defaults = array( 'post_status' => 'draft', 'post_type' => 'post', 'post_author' => 0,
if ( isset( $post_data['ping_status'] ) && $post_data['ping_status'] != 'open' && $post_data['ping_status'] != 'closed' )
unset( $post_data['ping_status'] );
- // Do some timestamp voodoo
+ // Do some timestamp voodoo.
if ( ! empty( $post_data['post_date_gmt'] ) ) {
- // We know this is supposed to be GMT, so we're going to slap that Z on there by force
+ // We know this is supposed to be GMT, so we're going to slap that Z on there by force.
$dateCreated = rtrim( $post_data['post_date_gmt']->getIso(), 'Z' ) . 'Z';
} elseif ( ! empty( $post_data['post_date'] ) ) {
$dateCreated = $post_data['post_date']->getIso();
$post_ID = $post_data['ID'];
if ( $post_data['post_type'] == 'post' ) {
- // Private and password-protected posts cannot be stickied.
- if ( $post_data['post_status'] == 'private' || ! empty( $post_data['post_password'] ) ) {
- // Error if the client tried to stick the post, otherwise, silently unstick.
- if ( ! empty( $post_data['sticky'] ) )
- return new IXR_Error( 401, __( 'Sorry, you cannot stick a private post.' ) );
- if ( $update )
- unstick_post( $post_ID );
- } elseif ( isset( $post_data['sticky'] ) ) {
- if ( ! current_user_can( $post_type->cap->edit_others_posts ) )
- return new IXR_Error( 401, __( 'Sorry, you are not allowed to stick this post.' ) );
- if ( $post_data['sticky'] )
- stick_post( $post_ID );
- else
- unstick_post( $post_ID );
+ $error = $this->_toggle_sticky( $post_data, $update );
+ if ( $error ) {
+ return $error;
}
}
if ( isset( $post_data['post_thumbnail'] ) ) {
- // empty value deletes, non-empty value adds/updates
+ // empty value deletes, non-empty value adds/updates.
if ( ! $post_data['post_thumbnail'] )
delete_post_thumbnail( $post_ID );
elseif ( ! get_post( absint( $post_data['post_thumbnail'] ) ) )
if ( isset( $post_data['terms'] ) || isset( $post_data['terms_names'] ) ) {
$post_type_taxonomies = get_object_taxonomies( $post_data['post_type'], 'objects' );
- // accumulate term IDs from terms and terms_names
+ // Accumulate term IDs from terms and terms_names.
$terms = array();
- // first validate the terms specified by ID
+ // First validate the terms specified by ID.
if ( isset( $post_data['terms'] ) && is_array( $post_data['terms'] ) ) {
$taxonomies = array_keys( $post_data['terms'] );
- // validating term ids
+ // Validating term ids.
foreach ( $taxonomies as $taxonomy ) {
if ( ! array_key_exists( $taxonomy , $post_type_taxonomies ) )
return new IXR_Error( 401, __( 'Sorry, one of the given taxonomies is not supported by the post type.' ) );
}
}
- // now validate terms specified by name
+ // Now validate terms specified by name.
if ( isset( $post_data['terms_names'] ) && is_array( $post_data['terms_names'] ) ) {
$taxonomies = array_keys( $post_data['terms_names'] );
if ( ! current_user_can( $post_type_taxonomies[$taxonomy]->cap->assign_terms ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to assign a term to one of the given taxonomies.' ) );
- // for hierarchical taxonomies, we can't assign a term when multiple terms in the hierarchy share the same name
+ /*
+ * For hierarchical taxonomies, we can't assign a term when multiple terms
+ * in the hierarchy share the same name.
+ */
$ambiguous_terms = array();
if ( is_taxonomy_hierarchical( $taxonomy ) ) {
$tax_term_names = get_terms( $taxonomy, array( 'fields' => 'names', 'hide_empty' => false ) );
- // count the number of terms with the same name
+ // Count the number of terms with the same name.
$tax_term_names_count = array_count_values( $tax_term_names );
- // filter out non-ambiguous term names
+ // Filter out non-ambiguous term names.
$ambiguous_tax_term_counts = array_filter( $tax_term_names_count, array( $this, '_is_greater_than_one') );
$ambiguous_terms = array_keys( $ambiguous_tax_term_counts );
$term = get_term_by( 'name', $term_name, $taxonomy );
if ( ! $term ) {
- // term doesn't exist, so check that the user is allowed to create new terms
+ // Term doesn't exist, so check that the user is allowed to create new terms.
if ( ! current_user_can( $post_type_taxonomies[$taxonomy]->cap->edit_terms ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to add a term to one of the given taxonomies.' ) );
- // create the new term
+ // Create the new term.
$term_info = wp_insert_term( $term_name, $taxonomy );
if ( is_wp_error( $term_info ) )
return new IXR_Error( 500, $term_info->get_error_message() );
$post_data['tax_input'] = $terms;
unset( $post_data['terms'], $post_data['terms_names'] );
} else {
- // do not allow direct submission of 'tax_input', clients must use 'terms' and/or 'terms_names'
+ // Do not allow direct submission of 'tax_input', clients must use 'terms' and/or 'terms_names'.
unset( $post_data['tax_input'], $post_data['post_category'], $post_data['tags_input'] );
}
unset( $post_data['post_format'] );
}
- // Handle enclosures
+ // Handle enclosures.
$enclosure = isset( $post_data['enclosure'] ) ? $post_data['enclosure'] : null;
$this->add_enclosure_if_new( $post_ID, $enclosure );
*
* @since 3.4.0
*
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - int $post_id
- * - array $content_struct
- * @return bool|IXR_Error true on success
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type int $post_id Post ID.
+ * @type array $content_struct Extra content arguments.
+ * }
+ * @return true|IXR_Error True on success, IXR_Error on failure.
*/
public function wp_editPost( $args ) {
if ( ! $this->minimum_args( $args, 5 ) )
}
}
- // convert the date field back to IXR form
+ // Convert the date field back to IXR form.
$post['post_date'] = $this->_convert_date( $post['post_date'] );
- // ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct,
- // since _insert_post will ignore the non-GMT date if the GMT date is set
+ /*
+ * Ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct,
+ * since _insert_post() will ignore the non-GMT date if the GMT date is set.
+ */
if ( $post['post_date_gmt'] == '0000-00-00 00:00:00' || isset( $content_struct['post_date'] ) )
unset( $post['post_date_gmt'] );
else
*
* @since 3.4.0
*
- * @uses wp_delete_post()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - int $post_id
- * @return bool|IXR_Error true on success
+ * @see wp_delete_post()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type int $post_id Post ID.
+ * }
+ * @return true|IXR_Error True on success, IXR_Error instance on failure.
*/
public function wp_deletePost( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
* groups are 'post' (all basic fields), 'taxonomies', 'custom_fields',
* and 'enclosure'.
*
- * @uses get_post()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unset)
- * - string $username
- * - string $password
- * - int $post_id
- * - array $fields optional
+ * @see get_post()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type int $post_id Post ID.
+ * @type array $fields The subset of post type fields to return.
+ * }
* @return array|IXR_Error Array contains (based on $fields parameter):
* - 'post_id'
* - 'post_title'
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $post_id = (int) $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $post_id = (int) $args[3];
if ( isset( $args[4] ) ) {
$fields = $args[4];
*
* @since 3.4.0
*
- * @param array $fields Array of post fields.
+ * @param array $fields Array of post fields. Default array contains 'post', 'terms', and 'custom_fields'.
* @param string $method Method name.
*/
$fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPost' );
*
* @since 3.4.0
*
- * The optional $filter parameter modifies the query used to retrieve posts.
- * Accepted keys are 'post_type', 'post_status', 'number', 'offset',
- * 'orderby', and 'order'.
- *
- * The optional $fields parameter specifies what fields will be included
- * in the response array.
- *
- * @uses wp_get_recent_posts()
- * @see wp_getPost() for more on $fields
- * @see get_posts() for more on $filter values
- *
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - array $filter optional
- * - array $fields optional
+ * @see wp_get_recent_posts()
+ * @see wp_getPost() for more on `$fields`
+ * @see get_posts() for more on `$filter` values
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type array $filter Optional. Modifies the query used to retrieve posts. Accepts 'post_type',
+ * 'post_status', 'number', 'offset', 'orderby', and 'order'.
+ * Default empty array.
+ * @type array $fields Optional. The subset of post type fields to return in the response array.
+ * }
* @return array|IXR_Error Array contains a collection of posts.
*/
public function wp_getPosts( $args ) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $filter = isset( $args[3] ) ? $args[3] : array();
+ $username = $args[1];
+ $password = $args[2];
+ $filter = isset( $args[3] ) ? $args[3] : array();
if ( isset( $args[4] ) ) {
$fields = $args[4];
if ( ! $posts_list )
return array();
- // holds all the posts data
+ // Holds all the posts data.
$struct = array();
foreach ( $posts_list as $post ) {
*
* @since 3.4.0
*
- * @uses wp_insert_term()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - array $content_struct
- * The $content_struct must contain:
- * - 'name'
- * - 'taxonomy'
- * Also, it can optionally contain:
- * - 'parent'
- * - 'description'
- * - 'slug'
- * @return string|IXR_Error term_id
+ * @see wp_insert_term()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type array $content_struct Content struct for adding a new term. The struct must contain
+ * the term 'name' and 'taxonomy'. Optional accepted values include
+ * 'parent', 'description', and 'slug'.
+ * }
+ * @return int|IXR_Error The term ID on success, or an IXR_Error object on failure.
*/
public function wp_newTerm( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $content_struct = $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $content_struct = $args[3];
if ( ! $user = $this->login( $username, $password ) )
return $this->error;
*
* @since 3.4.0
*
- * @uses wp_update_term()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - string $term_id
- * - array $content_struct
- * The $content_struct must contain:
- * - 'taxonomy'
- * Also, it can optionally contain:
- * - 'name'
- * - 'parent'
- * - 'description'
- * - 'slug'
- * @return bool|IXR_Error True, on success.
+ * @see wp_update_term()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type int $term_id Term ID.
+ * @type array $content_struct Content struct for editing a term. The struct must contain the
+ * term ''taxonomy'. Optional accepted values include 'name', 'parent',
+ * 'description', and 'slug'.
+ * }
+ * @return true|IXR_Error True on success, IXR_Error instance on failure.
*/
public function wp_editTerm( $args ) {
if ( ! $this->minimum_args( $args, 5 ) )
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $term_id = (int) $args[3];
- $content_struct = $args[4];
+ $username = $args[1];
+ $password = $args[2];
+ $term_id = (int) $args[3];
+ $content_struct = $args[4];
if ( ! $user = $this->login( $username, $password ) )
return $this->error;
*
* @since 3.4.0
*
- * @uses wp_delete_term()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - string $taxnomy_name
- * - string $term_id
- * @return boolean|IXR_Error If it suceeded true else a reason why not
+ * @see wp_delete_term()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type string $taxnomy_name Taxonomy name.
+ * @type int $term_id Term ID.
+ * }
+ * @return bool|IXR_Error True on success, IXR_Error instance on failure.
*/
public function wp_deleteTerm( $args ) {
if ( ! $this->minimum_args( $args, 5 ) )
*
* @since 3.4.0
*
- * @uses get_term()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - string $taxonomy
- * - string $term_id
- * @return array|IXR_Error Array contains:
+ * @see get_term()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type string $taxnomy Taxonomy name.
+ * @type string $term_id Term ID.
+ * }
+ * @return array|IXR_Error IXR_Error on failure, array on success, containing:
* - 'term_id'
* - 'name'
* - 'slug'
* The optional $filter parameter modifies the query used to retrieve terms.
* Accepted keys are 'number', 'offset', 'orderby', 'order', 'hide_empty', and 'search'.
*
- * @uses get_terms()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - string $taxonomy
- * - array $filter optional
- * @return array|IXR_Error terms
+ * @see get_terms()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type string $taxnomy Taxonomy name.
+ * @type array $filter Optional. Modifies the query used to retrieve posts. Accepts 'number',
+ * 'offset', 'orderby', 'order', 'hide_empty', and 'search'. Default empty array.
+ * }
+ * @return array|IXR_Error An associative array of terms data on success, IXR_Error instance otherwise.
*/
public function wp_getTerms( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
*
* @since 3.4.0
*
- * @uses get_taxonomy()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - string $taxonomy
- * @return array|IXR_Error (@see get_taxonomy())
+ * @see get_taxonomy()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type string $taxnomy Taxonomy name.
+ * @type array $fields Optional. Array of taxonomy fields to limit to in the return.
+ * Accepts 'labels', 'cap', 'menu', and 'object_type'.
+ * Default empty array.
+ * }
+ * @return array|IXR_Error An array of taxonomy data on success, IXR_Error instance otherwise.
*/
public function wp_getTaxonomy( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $taxonomy = $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $taxonomy = $args[3];
if ( isset( $args[4] ) ) {
$fields = $args[4];
*
* @since 3.4.0
*
- * @uses get_taxonomies()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * @return array taxonomies
+ * @see get_taxonomies()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id Blog ID (unused).
+ * @type string $username Username.
+ * @type string $password Password.
+ * @type array $filter Optional. An array of arguments for retrieving taxonomies.
+ * @type array $fields Optional. The subset of taxonomy fields to return.
+ * }
+ * @return array|IXR_Error An associative array of taxonomy data with returned fields determined
+ * by `$fields`, or an IXR_Error instance on failure.
*/
public function wp_getTaxonomies( $args ) {
if ( ! $this->minimum_args( $args, 3 ) )
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $filter = isset( $args[3] ) ? $args[3] : array( 'public' => true );
+ $username = $args[1];
+ $password = $args[2];
+ $filter = isset( $args[3] ) ? $args[3] : array( 'public' => true );
if ( isset( $args[4] ) ) {
$fields = $args[4];
* groups are 'basic' and 'all'.
*
* @uses get_userdata()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - int $user_id
- * - array $fields optional
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $user_id
+ * @type array $fields (optional)
+ * }
* @return array|IXR_Error Array contains (based on $fields parameter):
* - 'user_id'
* - 'username'
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $user_id = (int) $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $user_id = (int) $args[3];
if ( isset( $args[4] ) ) {
$fields = $args[4];
$user_data = get_userdata( $user_id );
if ( ! $user_data )
- return new IXR_Error( 404, __( 'Invalid user ID' ) );
+ return new IXR_Error( 404, __( 'Invalid user ID.' ) );
return $this->_prepare_user( $user_data, $fields );
}
* @uses get_users()
* @see wp_getUser() for more on $fields and return values
*
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - array $filter optional
- * - array $fields optional
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $filter (optional)
+ * @type array $fields (optional)
+ * }
* @return array|IXR_Error users data
*/
public function wp_getUsers( $args ) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $filter = isset( $args[3] ) ? $args[3] : array();
+ $username = $args[1];
+ $password = $args[2];
+ $filter = isset( $args[3] ) ? $args[3] : array();
if ( isset( $args[4] ) ) {
$fields = $args[4];
* Retrieve information about the requesting user.
*
* @uses get_userdata()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - array $fields optional
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $fields (optional)
+ * }
* @return array|IXR_Error (@see wp_getUser)
*/
public function wp_getProfile( $args ) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( isset( $args[3] ) ) {
$fields = $args[3];
* Edit user's profile.
*
* @uses wp_update_user()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - array $content_struct
- * It can optionally contain:
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $content_struct It can optionally contain:
* - 'first_name'
* - 'last_name'
* - 'website'
* - 'nickname'
* - 'nicename'
* - 'bio'
- * @return bool|IXR_Error True, on success.
+ * }
+ * @return true|IXR_Error True, on success.
*/
public function wp_editProfile( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
*
* @since 2.2.0
*
- * @param array $args Method parameters. Contains:
- * - blog_id (unused)
- * - page_id
- * - username
- * - password
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type int $page_id
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
- public function wp_getPage($args) {
- $this->escape($args);
+ public function wp_getPage( $args ) {
+ $this->escape( $args );
- $page_id = (int) $args[1];
- $username = $args[2];
- $password = $args[3];
+ $page_id = (int) $args[1];
+ $username = $args[2];
+ $password = $args[3];
if ( !$user = $this->login($username, $password) ) {
return $this->error;
*
* @since 2.2.0
*
- * @param array $args Method parameters. Contains:
- * - blog_id (unused)
- * - username
- * - password
- * - num_pages
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $num_pages
+ * }
* @return array|IXR_Error
*/
- public function wp_getPages($args) {
- $this->escape($args);
+ public function wp_getPages( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $num_pages = isset($args[3]) ? (int) $args[3] : 10;
+ $username = $args[1];
+ $password = $args[2];
+ $num_pages = isset($args[3]) ? (int) $args[3] : 10;
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.2.0
*
- * @param array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()}
+ * @see wp_xmlrpc_server::mw_newPost()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $content_struct
+ * }
* @return int|IXR_Error
*/
- public function wp_newPage($args) {
+ public function wp_newPage( $args ) {
// Items not escaped here will be escaped in newPost.
- $username = $this->escape($args[1]);
- $password = $this->escape($args[2]);
- $page = $args[3];
- $publish = $args[4];
+ $username = $this->escape( $args[1] );
+ $password = $this->escape( $args[2] );
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.2.0
*
- * @param array $args Method parameters.
- * @return bool|IXR_Error True, if success.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $page_id
+ * }
+ * @return true|IXR_Error True, if success.
*/
- public function wp_deletePage($args) {
- $this->escape($args);
+ public function wp_deletePage( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $page_id = (int) $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $page_id = (int) $args[3];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.2.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type int $page_id
+ * @type string $username
+ * @type string $password
+ * @type string $content
+ * @type string $publish
+ * }
* @return array|IXR_Error
*/
- public function wp_editPage($args) {
- // Items not escaped here will be escaped in editPost.
- $page_id = (int) $this->escape($args[1]);
- $username = $this->escape($args[2]);
- $password = $this->escape($args[3]);
- $content = $args[4];
- $publish = $args[5];
+ public function wp_editPage( $args ) {
+ // Items will be escaped in mw_editPost.
+ $page_id = (int) $args[1];
+ $username = $args[2];
+ $password = $args[3];
+ $content = $args[4];
+ $publish = $args[5];
- if ( !$user = $this->login($username, $password) )
+ $escaped_username = $this->escape( $username );
+ $escaped_password = $this->escape( $password );
+
+ if ( !$user = $this->login( $escaped_username, $escaped_password ) ) {
return $this->error;
+ }
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.editPage' );
*
* @since 2.2.0
*
- * @param array $args Method parameters.
+ * @global wpdb $wpdb
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
- public function wp_getPageList($args) {
+ public function wp_getPageList( $args ) {
global $wpdb;
- $this->escape($args);
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.2.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
- public function wp_getAuthors($args) {
-
- $this->escape($args);
+ public function wp_getAuthors( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.7.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
public function wp_getTags( $args ) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.2.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $category
+ * }
* @return int|IXR_Error Category ID.
*/
- public function wp_newCategory($args) {
- $this->escape($args);
+ public function wp_newCategory( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $category = $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $category = $args[3];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $category_id
+ * }
* @return bool|IXR_Error See {@link wp_delete_term()} for return info.
*/
- public function wp_deleteCategory($args) {
- $this->escape($args);
+ public function wp_deleteCategory( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $category_id = (int) $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $category_id = (int) $args[3];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.2.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $category
+ * @type int $max_results
+ * }
* @return array|IXR_Error
*/
- public function wp_suggestCategories($args) {
- $this->escape($args);
+ public function wp_suggestCategories( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $category = $args[3];
- $max_results = (int) $args[4];
+ $username = $args[1];
+ $password = $args[2];
+ $category = $args[3];
+ $max_results = (int) $args[4];
if ( !$user = $this->login($username, $password) )
return $this->error;
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.' ) );
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.suggestCategories' );
*
* @since 2.7.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $comment_id
+ * }
* @return array|IXR_Error
*/
public function wp_getComment($args) {
*
* @since 2.7.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $struct
+ * }
* @return array|IXR_Error Contains a collection of comments. See {@link wp_xmlrpc_server::wp_getComment()} for a description of each item contents
*/
- public function wp_getComments($args) {
- $this->escape($args);
+ public function wp_getComments( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $struct = isset( $args[3] ) ? $args[3] : array();
+ $username = $args[1];
+ $password = $args[2];
+ $struct = isset( $args[3] ) ? $args[3] : array();
if ( !$user = $this->login($username, $password) )
return $this->error;
if ( isset($struct['number']) )
$number = absint($struct['number']);
- $comments = get_comments( array('status' => $status, 'post_id' => $post_id, 'offset' => $offset, 'number' => $number ) );
+ $comments = get_comments( array( 'status' => $status, 'post_id' => $post_id, 'offset' => $offset, 'number' => $number ) );
$comments_struct = array();
-
- foreach ( $comments as $comment ) {
- $comments_struct[] = $this->_prepare_comment( $comment );
+ if ( is_array( $comments ) ) {
+ foreach ( $comments as $comment ) {
+ $comments_struct[] = $this->_prepare_comment( $comment );
+ }
}
return $comments_struct;
*
* @since 2.7.0
*
- * @param array $args Method parameters. Contains:
- * - blog_id (unused)
- * - username
- * - password
- * - comment_id
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $comment_ID
+ * }
* @return bool|IXR_Error {@link wp_delete_comment()}
*/
public function wp_deleteComment($args) {
$status = wp_delete_comment( $comment_ID );
- if ( true == $status ) {
+ if ( $status ) {
/**
* Fires after a comment has been successfully deleted via XML-RPC.
*
* - 'author_email'
* - 'content'
* - 'date_created_gmt'
- * - 'status'. Common statuses are 'approve', 'hold', 'spam'. See {@link get_comment_statuses()} for more details
+ * - 'status'. Common statuses are 'approve', 'hold', 'spam'. See get_comment_statuses() for more details
*
* @since 2.7.0
*
- * @param array $args. Contains:
- * - blog_id (unused)
- * - username
- * - password
- * - comment_id
- * - content_struct
- * @return bool|IXR_Error True, on success.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $comment_ID
+ * @type array $content_struct
+ * }
+ * @return true|IXR_Error True, on success.
*/
- public function wp_editComment($args) {
- $this->escape($args);
+ public function wp_editComment( $args ) {
+ $this->escape( $args );
$username = $args[1];
$password = $args[2];
*
* @since 2.7.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type string|int $post
+ * @type array $content_struct
+ * }
* @return int|IXR_Error {@link wp_new_comment()}
*/
public function wp_newComment($args) {
$this->escape($args);
- $username = $args[1];
- $password = $args[2];
- $post = $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $post = $args[3];
$content_struct = $args[4];
/**
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;
}
*
* @since 2.7.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
public function wp_getCommentStatusList($args) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $post_id
+ * }
* @return array|IXR_Error
*/
public function wp_getCommentCount( $args ) {
- $this->escape($args);
+ $this->escape( $args );
$username = $args[1];
$password = $args[2];
*
* @since 2.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
public function wp_getPostStatusList( $args ) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
public function wp_getPageStatusList( $args ) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.6.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
public function wp_getPageTemplates( $args ) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 2.6.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $options
+ * }
* @return array|IXR_Error
*/
public function wp_getOptions( $args ) {
*
* @since 2.6.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $options
+ * }
* @return array|IXR_Error
*/
public function wp_setOptions( $args ) {
*
* @since 3.1.0
*
- * @param array $args Method parameters. Contains:
- * - blog_id (unused)
- * - username
- * - password
- * - attachment_id
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $attachment_id
+ * }
* @return array|IXR_Error Associative array contains:
* - 'date_created_gmt'
* - 'parent'
* - 'description'
* - 'metadata'
*/
- public function wp_getMediaItem($args) {
- $this->escape($args);
+ public function wp_getMediaItem( $args ) {
+ $this->escape( $args );
$username = $args[1];
$password = $args[2];
*
* The defaults are as follows:
* - 'number' - Default is 5. Total number of media items to retrieve.
- * - 'offset' - Default is 0. See {@link WP_Query::query()} for more.
+ * - 'offset' - Default is 0. See WP_Query::query() for more.
* - 'parent_id' - Default is ''. The post where the media item is attached. Empty string shows all media items. 0 shows unattached media items.
* - 'mime_type' - Default is ''. Filter by mime type (e.g., 'image/jpeg', 'application/pdf')
*
* @since 3.1.0
*
- * @param array $args Method parameters. Contains:
- * - blog_id (unused)
- * - username
- * - password
- * - filter
- * @return array|IXR_Error Contains a collection of media items. See {@link wp_xmlrpc_server::wp_getMediaItem()} for a description of each item contents
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $struct
+ * }
+ * @return array|IXR_Error Contains a collection of media items. See wp_xmlrpc_server::wp_getMediaItem() for a description of each item contents
*/
public function wp_getMediaLibrary($args) {
$this->escape($args);
}
/**
- * Retrieves a list of post formats used by the site
- *
- * @since 3.1.0
- *
- * @param array $args Method parameters. Contains:
- * - blog_id (unused)
- * - username
- * - password
- * @return array|IXR_Error
- */
+ * Retrieves a list of post formats used by the site.
+ *
+ * @since 3.1.0
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
+ * @return array|IXR_Error List of post formats, otherwise IXR_Error object.
+ */
public function wp_getPostFormats( $args ) {
$this->escape( $args );
$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' ) ) {
*
* @since 3.4.0
*
- * @uses get_post_type_object()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - string $post_type_name
- * - array $fields
+ * @see get_post_type_object()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type string $post_type_name
+ * @type array $fields (optional)
+ * }
* @return array|IXR_Error Array contains:
* - 'labels'
* - 'description'
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getPostType' );
- if( ! post_type_exists( $post_type_name ) )
+ if ( ! post_type_exists( $post_type_name ) )
return new IXR_Error( 403, __( 'Invalid post type' ) );
$post_type = get_post_type_object( $post_type_name );
- if( ! current_user_can( $post_type->cap->edit_posts ) )
+ if ( ! current_user_can( $post_type->cap->edit_posts ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post type.' ) );
return $this->_prepare_post_type( $post_type, $fields );
*
* @since 3.4.0
*
- * @uses get_post_types()
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - array $filter
- * - array $fields
+ * @see get_post_types()
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $filter (optional)
+ * @type array $fields (optional)
+ * }
* @return array|IXR_Error
*/
public function wp_getPostTypes( $args ) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $filter = isset( $args[3] ) ? $args[3] : array( 'public' => true );
+ $username = $args[1];
+ $password = $args[2];
+ $filter = isset( $args[3] ) ? $args[3] : array( 'public' => true );
if ( isset( $args[4] ) ) {
$fields = $args[4];
$struct = array();
foreach( $post_types as $post_type ) {
- if( ! current_user_can( $post_type->cap->edit_posts ) )
+ if ( ! current_user_can( $post_type->cap->edit_posts ) )
continue;
$struct[$post_type->name] = $this->_prepare_post_type( $post_type, $fields );
* @uses wp_get_post_revisions()
* @see wp_getPost() for more on $fields
*
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - int $post_id
- * - array $fields
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $post_id
+ * @type array $fields (optional)
+ * }
* @return array|IXR_Error contains a collection of posts.
*/
public function wp_getRevisions( $args ) {
$this->escape( $args );
- $username = $args[1];
- $password = $args[2];
- $post_id = (int) $args[3];
+ $username = $args[1];
+ $password = $args[2];
+ $post_id = (int) $args[3];
if ( isset( $args[4] ) ) {
$fields = $args[4];
do_action( 'xmlrpc_call', 'wp.getRevisions' );
if ( ! $post = get_post( $post_id ) )
- return new IXR_Error( 404, __( 'Invalid post ID' ) );
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( ! current_user_can( 'edit_post', $post_id ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts.' ) );
*
* @uses wp_restore_post_revision()
*
- * @param array $args Method parameters. Contains:
- * - int $blog_id (unused)
- * - string $username
- * - string $password
- * - int $post_id
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $revision_id
+ * }
* @return bool|IXR_Error false if there was an error restoring, true if success.
*/
public function wp_restoreRevision( $args ) {
do_action( 'xmlrpc_call', 'wp.restoreRevision' );
if ( ! $revision = wp_get_post_revision( $revision_id ) )
- return new IXR_Error( 404, __( 'Invalid post ID' ) );
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( wp_is_post_autosave( $revision ) )
- return new IXR_Error( 404, __( 'Invalid post ID' ) );
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( ! $post = get_post( $revision->post_parent ) )
- return new IXR_Error( 404, __( 'Invalid post ID' ) );
+ return new IXR_Error( 404, __( 'Invalid post ID.' ) );
if ( ! current_user_can( 'edit_post', $revision->post_parent ) )
return new IXR_Error( 401, __( 'Sorry, you cannot edit this post.' ) );
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
public function blogger_getUsersBlogs($args) {
$this->escape($args);
$username = $args[1];
- $password = $args[2];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
- public function blogger_getUserInfo($args) {
-
- $this->escape($args);
+ public function blogger_getUserInfo( $args ) {
+ $this->escape( $args );
$username = $args[1];
- $password = $args[2];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
- public function blogger_getPost($args) {
-
- $this->escape($args);
+ public function blogger_getPost( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[1];
+ $post_ID = (int) $args[1];
$username = $args[2];
- $password = $args[3];
+ $password = $args[3];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type string $appkey (unused)
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $numberposts (optional)
+ * }
* @return array|IXR_Error
*/
- public function blogger_getRecentPosts($args) {
+ public function blogger_getRecentPosts( $args ) {
$this->escape($args);
// $args[0] = appkey - ignored
$username = $args[2];
- $password = $args[3];
+ $password = $args[3];
if ( isset( $args[4] ) )
$query = array( 'numberposts' => absint( $args[4] ) );
else
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type string $appkey (unused)
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type string $content
+ * @type string $publish
+ * }
* @return int|IXR_Error
*/
- public function blogger_newPost($args) {
-
- $this->escape($args);
+ public function blogger_newPost( $args ) {
+ $this->escape( $args );
$username = $args[2];
- $password = $args[3];
- $content = $args[4];
- $publish = $args[5];
+ $password = $args[3];
+ $content = $args[4];
+ $publish = $args[5];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return bool|IXR_Error true when done.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * @type string $content
+ * }
+ * @return true|IXR_Error true when done.
*/
public function blogger_editPost( $args ) {
$this->escape($args);
- $post_ID = (int) $args[1];
- $username = $args[2];
- $password = $args[3];
- $content = $args[4];
- $publish = $args[5];
+ $post_ID = (int) $args[1];
+ $username = $args[2];
+ $password = $args[3];
+ $content = $args[4];
if ( ! $user = $this->login( $username, $password ) ) {
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return bool|IXR_Error True when post is deleted.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * }
+ * @return true|IXR_Error True when post is deleted.
*/
- public function blogger_deletePost($args) {
- $this->escape($args);
+ public function blogger_deletePost( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[1];
- $username = $args[2];
- $password = $args[3];
- $publish = $args[4];
+ $post_ID = (int) $args[1];
+ $username = $args[2];
+ $password = $args[3];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters. Contains:
- * - blog_id (unused)
- * - username
- * - password
- * - content_struct
- * - publish
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $content_struct
+ * @type int $publish
+ * }
* @return int|IXR_Error
*/
public function mw_newPost($args) {
$this->escape($args);
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
$content_struct = $args[3];
- $publish = isset( $args[4] ) ? $args[4] : 0;
+ $publish = isset( $args[4] ) ? $args[4] : 0;
if ( !$user = $this->login($username, $password) )
return $this->error;
break;
default:
return new IXR_Error( 401, __( 'Invalid post type' ) );
- break;
}
$author = get_userdata( $content_struct['wp_author_id'] );
if ( ! $author )
$comment_status = 'open';
break;
default:
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
break;
}
} else {
$comment_status = 'open';
break;
default:
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
break;
}
}
} else {
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
}
if ( isset($content_struct['mt_allow_pings']) ) {
$ping_status = 'open';
break;
default:
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
break;
}
} else {
$ping_status = 'open';
break;
default:
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
break;
}
}
} else {
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
}
if ( $post_more )
// 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']) )
*
* @since 2.1.0
*
+ * @global wpdb $wpdb
+ *
* @param int $post_ID Post ID.
* @param string $post_content Post Content for attachment.
*/
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $content_struct
+ * @type int $publish
+ * }
* @return bool|IXR_Error True on success.
*/
- public function mw_editPost($args) {
-
- $this->escape($args);
+ public function mw_editPost( $args ) {
+ $this->escape( $args );
$post_ID = (int) $args[0];
$username = $args[1];
$postdata = get_post( $post_ID, ARRAY_A );
- // If there is no post data for the give post id, stop
- // now and return an error. Other wise a new post will be
- // created (which was the old behavior).
+ /*
+ * If there is no post data for the give post id, stop now and return an error.
+ * Otherwise a new post will be created (which was the old behavior).
+ */
if ( ! $postdata || empty( $postdata[ 'ID' ] ) )
return new IXR_Error( 404, __( 'Invalid post ID.' ) );
$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'];
$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']) ) {
$comment_status = 'open';
break;
default:
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
break;
}
} else {
$comment_status = 'open';
break;
default:
- $comment_status = get_option('default_comment_status');
+ $comment_status = get_default_comment_status( $post_type );
break;
}
}
$ping_status = 'open';
break;
default:
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
break;
}
} else {
$ping_status = 'open';
break;
default:
- $ping_status = get_option('default_ping_status');
+ $ping_status = get_default_comment_status( $post_type, 'pingback' );
break;
}
}
$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 ( ( '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 )
$to_ping = implode(' ', $to_ping);
}
- // Do some timestamp voodoo
+ // Do some timestamp voodoo.
if ( !empty( $content_struct['date_created_gmt'] ) )
- // We know this is supposed to be GMT, so we're going to slap that Z on there by force
+ // We know this is supposed to be GMT, so we're going to slap that Z on there by force.
$dateCreated = rtrim( $content_struct['date_created_gmt']->getIso(), 'Z' ) . 'Z';
elseif ( !empty( $content_struct['dateCreated']) )
$dateCreated = $content_struct['dateCreated']->getIso();
$post_date_gmt = $postdata['post_date_gmt'];
}
- // We've got all the data -- post it:
+ // We've got all the data -- post it.
$newpost = compact('ID', 'post_content', 'post_title', 'post_category', 'post_status', 'post_excerpt', 'comment_status', 'ping_status', 'post_date', 'post_date_gmt', 'to_ping', 'post_name', 'post_password', 'post_parent', 'menu_order', 'post_author', 'tags_input', 'page_template');
$result = wp_update_post($newpost, true);
// Only posts can be sticky
if ( $post_type == 'post' && isset( $content_struct['sticky'] ) ) {
- if ( $content_struct['sticky'] == true )
- stick_post( $post_ID );
- elseif ( $content_struct['sticky'] == false )
- unstick_post( $post_ID );
+ $data = $newpost;
+ $data['sticky'] = $content_struct['sticky'];
+ $data['post_type'] = 'post';
+ $error = $this->_toggle_sticky( $data, true );
+ if ( $error ) {
+ return $error;
+ }
}
if ( isset($content_struct['custom_fields']) )
$this->set_custom_fields($post_ID, $content_struct['custom_fields']);
if ( isset ( $content_struct['wp_post_thumbnail'] ) ) {
- // empty value deletes, non-empty value adds/updates
+
+ // Empty value deletes, non-empty value adds/updates.
if ( empty( $content_struct['wp_post_thumbnail'] ) ) {
delete_post_thumbnail( $post_ID );
} else {
unset( $content_struct['wp_post_thumbnail'] );
}
- // Handle enclosures
+ // Handle enclosures.
$thisEnclosure = isset($content_struct['enclosure']) ? $content_struct['enclosure'] : null;
$this->add_enclosure_if_new($post_ID, $thisEnclosure);
$this->attach_uploads( $ID, $post_content );
- // Handle post formats if assigned, validation is handled
- // earlier in this function
+ // Handle post formats if assigned, validation is handled earlier in this function.
if ( isset( $content_struct['wp_post_format'] ) )
set_post_format( $post_ID, $content_struct['wp_post_format'] );
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
- public function mw_getPost($args) {
-
- $this->escape($args);
+ public function mw_getPost( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $post_ID = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $numberposts
+ * }
* @return array|IXR_Error
*/
- public function mw_getRecentPosts($args) {
-
- $this->escape($args);
+ public function mw_getRecentPosts( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( isset( $args[3] ) )
$query = array( 'numberposts' => absint( $args[3] ) );
else
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
- public function mw_getCategories($args) {
-
- $this->escape($args);
+ public function mw_getCategories( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @global wpdb $wpdb
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type array $data
+ * }
* @return array|IXR_Error
*/
- public function mw_newMediaObject($args) {
+ public function mw_newMediaObject( $args ) {
global $wpdb;
- $username = $this->escape($args[1]);
- $password = $this->escape($args[2]);
- $data = $args[3];
+ $username = $this->escape( $args[1] );
+ $password = $this->escape( $args[2] );
+ $data = $args[3];
$name = sanitize_file_name( $data['name'] );
$type = $data['type'];
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * @type int $numberposts
+ * }
* @return array|IXR_Error
*/
- public function mt_getRecentPostTitles($args) {
-
- $this->escape($args);
+ public function mt_getRecentPostTitles( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( isset( $args[3] ) )
$query = array( 'numberposts' => absint( $args[3] ) );
else
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $blog_id (unused)
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
- public function mt_getCategoryList($args) {
-
- $this->escape($args);
+ public function mt_getCategoryList( $args ) {
+ $this->escape( $args );
- $username = $args[1];
- $password = $args[2];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * }
* @return array|IXR_Error
*/
- public function mt_getPostCategories($args) {
-
- $this->escape($args);
+ public function mt_getPostCategories( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $post_ID = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
- * @return bool|IXR_Error True on success.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * @type array $categories
+ * }
+ * @return true|IXR_Error True on success.
*/
- public function mt_setPostCategories($args) {
-
- $this->escape($args);
+ public function mt_setPostCategories( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[0];
- $username = $args[1];
+ $post_ID = (int) $args[0];
+ $username = $args[1];
$password = $args[2];
- $categories = $args[3];
+ $categories = $args[3];
if ( !$user = $this->login($username, $password) )
return $this->error;
*
* @since 1.5.0
*
- * @param array $args Method parameters.
* @return array
*/
- public function mt_supportedMethods($args) {
-
+ public function mt_supportedMethods() {
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'mt.supportedMethods' );
- $supported_methods = array();
- foreach ( $this->methods as $key => $value ) {
- $supported_methods[] = $key;
- }
-
- return $supported_methods;
+ return array_keys( $this->methods );
}
/**
* Retrieve an empty array because we don't support per-post text filters.
*
* @since 1.5.0
- *
- * @param array $args Method parameters.
*/
- public function mt_supportedTextFilters($args) {
+ public function mt_supportedTextFilters() {
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'mt.supportedTextFilters' );
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @global wpdb $wpdb
+ *
+ * @param int $post_ID
* @return array|IXR_Error
*/
- public function mt_getTrackbackPings($args) {
-
+ public function mt_getTrackbackPings( $post_ID ) {
global $wpdb;
- $post_ID = intval($args);
-
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'mt.getTrackbackPings' );
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type int $post_ID
+ * @type string $username
+ * @type string $password
+ * }
* @return int|IXR_Error
*/
- public function mt_publishPost($args) {
-
- $this->escape($args);
+ public function mt_publishPost( $args ) {
+ $this->escape( $args );
- $post_ID = (int) $args[0];
- $username = $args[1];
- $password = $args[2];
+ $post_ID = (int) $args[0];
+ $username = $args[1];
+ $password = $args[2];
if ( !$user = $this->login($username, $password) )
return $this->error;
$postdata['post_category'] = $cats;
$this->escape($postdata);
- $result = wp_update_post($postdata);
-
- return $result;
+ return wp_update_post( $postdata );
}
/* PingBack functions
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @global wpdb $wpdb
+ * @global string $wp_version
+ *
+ * @param array $args {
+ * Method arguments. Note: arguments must be ordered as documented.
+ *
+ * @type string $pagelinkedfrom
+ * @type string $pagelinkedto
+ * }
* @return string|IXR_Error
*/
- public function pingback_ping($args) {
- global $wpdb;
+ public function pingback_ping( $args ) {
+ global $wpdb, $wp_version;
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'pingback.ping' );
- $this->escape($args);
-
- $pagelinkedfrom = $args[0];
- $pagelinkedto = $args[1];
-
- $title = '';
+ $this->escape( $args );
- $pagelinkedfrom = str_replace('&', '&', $pagelinkedfrom);
- $pagelinkedto = str_replace('&', '&', $pagelinkedto);
- $pagelinkedto = str_replace('&', '&', $pagelinkedto);
+ $pagelinkedfrom = str_replace( '&', '&', $args[0] );
+ $pagelinkedto = str_replace( '&', '&', $args[1] );
+ $pagelinkedto = str_replace( '&', '&', $pagelinkedto );
/**
* Filter the pingback source URI.
$remote_ip = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );
/** This filter is documented in wp-includes/class-http.php */
- $user_agent = apply_filters( 'http_headers_useragent', 'WordPress/' . $GLOBALS['wp_version'] . '; ' . get_bloginfo( 'url' ) );
+ $user_agent = apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ) );
// Let's check the remote site
$http_api_args = array(
*
* @since 1.5.0
*
- * @param array $args Method parameters.
+ * @global wpdb $wpdb
+ *
+ * @param string $url
* @return array|IXR_Error
*/
- public function pingback_extensions_getPingbacks($args) {
-
+ public function pingback_extensions_getPingbacks( $url ) {
global $wpdb;
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'pingback.extensions.getPingbacks' );
- $this->escape($args);
-
- $url = $args;
+ $url = $this->escape( $url );
$post_ID = url_to_postid($url);
if ( !$post_ID ) {
/**
* @param integer $code
* @param string $message
+ * @return IXR_Error
*/
protected function pingback_error( $code, $message ) {
/**
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff