wp_xmlrpc_server::wp_newPost( array $args ): int|IXR_Error

Create a new post for any registered post type.


Parameters

$args array Required
Method arguments. Note: top-level arguments must be ordered as documented.
  • blog_idint
    Blog ID (unused).
  • usernamestring
    Username.
  • passwordstring
    Password.
  • content_structarray
    Content struct for adding a new post. See wp_insert_post() for information on additional post fields
    • post_typestring
      Post type. Default 'post'.
    • post_statusstring
      Post status. Default 'draft'
    • post_titlestring
      Post title.
    • post_authorint
      Post author ID.
    • post_excerptstring
      Post excerpt.
    • post_contentstring
      Post content.
    • post_date_gmtstring
      Post date in GMT.
    • post_datestring
      Post date.
    • post_passwordstring
      Post password (20-character limit).
    • comment_statusstring
      Post comment enabled status. Accepts 'open' or 'closed'.
    • ping_statusstring
      Post ping status. Accepts 'open' or 'closed'.
    • stickybool
      Whether the post should be sticky. Automatically false if $post_status is 'private'.
    • post_thumbnailint
      ID of an image to use as the post thumbnail/featured image.
    • custom_fieldsarray
      Array of meta key/value pairs to add to the post.
    • termsarray
      Associative array with taxonomy names as keys and arrays of term IDs as values.
    • terms_namesarray
      Associative array with taxonomy names as keys and arrays of term names as values.
    • enclosurearray
      Array of feed enclosure data to add to post meta.
      • urlstring
        URL for the feed enclosure.
      • lengthint
        Size in bytes of the enclosure.
      • typestring
        Mime-type for the enclosure.
        }

Top ↑

Return

int|IXR_Error Post ID on success, IXR_Error instance otherwise.


Top ↑

Source

File: wp-includes/class-wp-xmlrpc-server.php. View all references

public function wp_newPost( $args ) {
	if ( ! $this->minimum_args( $args, 4 ) ) {
		return $this->error;
	}

	$this->escape( $args );

	$username       = $args[1];
	$password       = $args[2];
	$content_struct = $args[3];

	$user = $this->login( $username, $password );
	if ( ! $user ) {
		return $this->error;
	}

	// Convert the date field back to IXR form.
	if ( isset( $content_struct['post_date'] ) && ! ( $content_struct['post_date'] instanceof IXR_Date ) ) {
		$content_struct['post_date'] = $this->_convert_date( $content_struct['post_date'] );
	}

	/*
	 * Ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct,
	 * since _insert_post() will ignore the non-GMT date if the GMT date is set.
	 */
	if ( isset( $content_struct['post_date_gmt'] ) && ! ( $content_struct['post_date_gmt'] instanceof IXR_Date ) ) {
		if ( '0000-00-00 00:00:00' === $content_struct['post_date_gmt'] || isset( $content_struct['post_date'] ) ) {
			unset( $content_struct['post_date_gmt'] );
		} else {
			$content_struct['post_date_gmt'] = $this->_convert_date( $content_struct['post_date_gmt'] );
		}
	}

	/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
	do_action( 'xmlrpc_call', 'wp.newPost', $args, $this );

	unset( $content_struct['ID'] );

	return $this->_insert_post( $user, $content_struct );
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
3.4.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.