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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

true|IXR_Error

True on success.

Performance profile

How much work a call to wp_xmlrpc_server::mw_editPost() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

44–249

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 559.

Plugin surface

2 hooks

Third-party callbacks on 'xmlrpc_call', 'xmlrpc_call_success_mw_editPost' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()called directly
• querycontent queryget_post()called directly
• optionoption read or writeget_option()one call below wp_xmlrpc_server::mw_editPost()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 187 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::mw_editPost() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 2

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

1. 1
   do_action( xmlrpc_call )actionline 5788 (+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 6107 (+334 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 code

View on Trac ↗View on GitHub ↗

5773	public function mw_editPost( $args ) {5774		$this->escape( $args );5775 5776		$post_id        = (int) $args[0];5777		$username       = $args[1];5778		$password       = $args[2];5779		$content_struct = $args[3];5780		$publish        = $args[4] ?? 0;5781 5782		$user = $this->login( $username, $password );5783		if ( ! $user ) {5784			return $this->error;5785		}5786 5787		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */5788		do_action( 'xmlrpc_call', 'metaWeblog.editPost', $args, $this );5789 5790		$postdata = get_post( $post_id, ARRAY_A );5791 5792		/*5793		 * If there is no post data for the give post ID, stop now and return an error.5794		 * Otherwise a new post will be created (which was the old behavior).5795		 */5796		if ( ! $postdata || empty( $postdata['ID'] ) ) {5797			return new IXR_Error( 404, __( 'Invalid post ID.' ) );5798		}5799 5800		if ( ! current_user_can( 'edit_post', $post_id ) ) {5801			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) );5802		}5803 5804		// Use wp.editPost to edit post types other than post and page.5805		if ( ! in_array( $postdata['post_type'], array( 'post', 'page' ), true ) ) {5806			return new IXR_Error( 401, __( 'Invalid post type.' ) );5807		}5808 5809		// Thwart attempt to change the post type.5810		if ( ! empty( $content_struct['post_type'] ) && ( $content_struct['post_type'] !== $postdata['post_type'] ) ) {5811			return new IXR_Error( 401, __( 'The post type may not be changed.' ) );5812		}5813 5814		// Check for a valid post format if one was given.5815		if ( isset( $content_struct['wp_post_format'] ) ) {5816			$content_struct['wp_post_format'] = sanitize_key( $content_struct['wp_post_format'] );5817			if ( ! array_key_exists( $content_struct['wp_post_format'], get_post_format_strings() ) ) {5818				return new IXR_Error( 404, __( 'Invalid post format.' ) );5819			}5820		}5821 5822		$this->escape( $postdata );5823 5824		$post_id        = $postdata['ID'];5825		$post_content   = $postdata['post_content'];5826		$post_title     = $postdata['post_title'];5827		$post_excerpt   = $postdata['post_excerpt'];5828		$post_password  = $postdata['post_password'];5829		$post_parent    = $postdata['post_parent'];5830		$post_type      = $postdata['post_type'];5831		$menu_order     = $postdata['menu_order'];5832		$ping_status    = $postdata['ping_status'];5833		$comment_status = $postdata['comment_status'];5834 5835		// Let WordPress manage slug if none was provided.5836		$post_name = $postdata['post_name'];5837		if ( isset( $content_struct['wp_slug'] ) ) {5838			$post_name = $content_struct['wp_slug'];5839		}5840 5841		// Only use a password if one was given.5842		if ( isset( $content_struct['wp_password'] ) ) {5843			$post_password = $content_struct['wp_password'];5844		}5845 5846		// Only set a post parent if one was given.5847		if ( isset( $content_struct['wp_page_parent_id'] ) ) {5848			$post_parent = $content_struct['wp_page_parent_id'];5849		}5850 5851		// Only set the 'menu_order' if it was given.5852		if ( isset( $content_struct['wp_page_order'] ) ) {

Changelog

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 7.1.0 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.