wp_xmlrpc_server::mw_editPost( array $args ): true|IXR_Error

Parameters

$argsarray

Method arguments. Note: arguments must be ordered as documented.

• $0int

  Post ID.

• $1string

  Username.

• $2string

  Password.

• $3array

  Content structure.

• $4intdefault: 0

  Optional. Publish flag. 0 for draft, 1 for publish.

Return

true|IXR_Error

True on success.

Hooks fired · 2

2 hooks fire while wp_xmlrpc_server::mw_editPost() runs, in this order:

1. 1
   do_action( xmlrpc_call )actionline 5743 (+15 into the body)

   Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

2. 2
   do_action( xmlrpc_call_success_mw_editPost )actionline 6039 (+311 into the body)

   Fires after a post has been successfully updated via the XML-RPC MovableType API.

Uses · 21

• do_action()Calls the callback functions that have been added to an action hook.
• get_post()Retrieves post data given a post ID or post object.
• __()Retrieves the translation of $text.
• current_user_can()Returns whether the current user has the specified capability.
• sanitize_key()Sanitizes a string key.
• get_post_format_strings()Returns an array of post format slugs to their translated and pretty display versions
• get_default_comment_status()Gets the default comment status for a post type.
• get_cat_ID()Retrieves the ID of a category from its name.
• iso8601_to_datetime()Given an ISO 8601 (Ymd\TH:i:sO) date, returns a MySQL DateTime (Y-m-d H:i:s) format used by post_date[_gmt].
• wp_update_post()Updates a post with new post data.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• delete_post_thumbnail()Removes the thumbnail (featured image) from the given post.

Used by · 1

• wp_xmlrpc_server::wp_editPage()Edits a page.

Source

View on Trac ↗View on GitHub ↗

5728	public function mw_editPost( $args ) {5729		$this->escape( $args );5730 5731		$post_id        = (int) $args[0];5732		$username       = $args[1];5733		$password       = $args[2];5734		$content_struct = $args[3];5735		$publish        = isset( $args[4] ) ? $args[4] : 0;5736 5737		$user = $this->login( $username, $password );5738		if ( ! $user ) {5739			return $this->error;5740		}5741 5742		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */5743		do_action( 'xmlrpc_call', 'metaWeblog.editPost', $args, $this );5744 5745		$postdata = get_post( $post_id, ARRAY_A );5746 5747		/*5748		 * If there is no post data for the give post ID, stop now and return an error.5749		 * Otherwise a new post will be created (which was the old behavior).5750		 */5751		if ( ! $postdata || empty( $postdata['ID'] ) ) {5752			return new IXR_Error( 404, __( 'Invalid post ID.' ) );5753		}5754 5755		if ( ! current_user_can( 'edit_post', $post_id ) ) {5756			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) );5757		}5758 5759		// Use wp.editPost to edit post types other than post and page.5760		if ( ! in_array( $postdata['post_type'], array( 'post', 'page' ), true ) ) {5761			return new IXR_Error( 401, __( 'Invalid post type.' ) );5762		}5763 5764		// Thwart attempt to change the post type.5765		if ( ! empty( $content_struct['post_type'] ) && ( $content_struct['post_type'] != $postdata['post_type'] ) ) {5766			return new IXR_Error( 401, __( 'The post type may not be changed.' ) );5767		}5768 5769		// Check for a valid post format if one was given.5770		if ( isset( $content_struct['wp_post_format'] ) ) {5771			$content_struct['wp_post_format'] = sanitize_key( $content_struct['wp_post_format'] );5772			if ( ! array_key_exists( $content_struct['wp_post_format'], get_post_format_strings() ) ) {5773				return new IXR_Error( 404, __( 'Invalid post format.' ) );5774			}5775		}5776 5777		$this->escape( $postdata );5778 5779		$ID             = $postdata['ID'];5780		$post_content   = $postdata['post_content'];5781		$post_title     = $postdata['post_title'];5782		$post_excerpt   = $postdata['post_excerpt'];5783		$post_password  = $postdata['post_password'];5784		$post_parent    = $postdata['post_parent'];5785		$post_type      = $postdata['post_type'];5786		$menu_order     = $postdata['menu_order'];5787		$ping_status    = $postdata['ping_status'];5788		$comment_status = $postdata['comment_status'];5789 5790		// Let WordPress manage slug if none was provided.5791		$post_name = $postdata['post_name'];5792		if ( isset( $content_struct['wp_slug'] ) ) {5793			$post_name = $content_struct['wp_slug'];5794		}5795 5796		// Only use a password if one was given.5797		if ( isset( $content_struct['wp_password'] ) ) {5798			$post_password = $content_struct['wp_password'];5799		}5800 5801		// Only set a post parent if one was given.5802		if ( isset( $content_struct['wp_page_parent_id'] ) ) {5803			$post_parent = $content_struct['wp_page_parent_id'];5804		}5805 5806		// Only set the 'menu_order' if it was given.5807		if ( isset( $content_struct['wp_page_order'] ) ) {

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-xmlrpc-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.