wp_xmlrpc_server::blogger_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

  Blog ID (unused).

• $1int

  Post ID.

• $2string

  Username.

• $3string

  Password.

• $4string

  Content @type int $5 Publish flag. 0 for draft, 1 for publish.

Return value

true|IXR_Error

true when done.

Performance profile

How much work a call to wp_xmlrpc_server::blogger_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

18–97

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

Plugin surface

2 hooks

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly
• querycontent queryget_post()called directly

Further down the call graph this can also reach option, 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 · 8 distinct outcomes

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

Hooks and filters fired · 2

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

1. 1
   do_action( xmlrpc_call )actionline 5224 (+16 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_blogger_editPost )actionline 5265 (+57 into the body)

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

Uses · 12

• 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.
• xmlrpc_removepostdata()XML-RPC XML content without title and category elements.
• xmlrpc_getposttitle()Retrieves post title from XML-RPC XML.
• xmlrpc_getpostcategory()Retrieves the post category or categories from XML-RPC XML.
• wp_update_post()Updates a post with new post data.
• wp_xmlrpc_server::escape()Escapes string or array of strings for database.
• wp_xmlrpc_server::login()Logs user in.
• IXR_Error::__construct()PHP5 constructor.
• wp_xmlrpc_server::attach_uploads()Attaches an upload to a post.

Source code

View on Trac ↗View on GitHub ↗

5208	public function blogger_editPost( $args ) {5209 5210		$this->escape( $args );5211 5212		$post_id  = (int) $args[1];5213		$username = $args[2];5214		$password = $args[3];5215		$content  = $args[4];5216		$publish  = $args[5];5217 5218		$user = $this->login( $username, $password );5219		if ( ! $user ) {5220			return $this->error;5221		}5222 5223		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */5224		do_action( 'xmlrpc_call', 'blogger.editPost', $args, $this );5225 5226		$actual_post = get_post( $post_id, ARRAY_A );5227 5228		if ( ! $actual_post || 'post' !== $actual_post['post_type'] ) {5229			return new IXR_Error( 404, __( 'Sorry, no such post.' ) );5230		}5231 5232		$this->escape( $actual_post );5233 5234		if ( ! current_user_can( 'edit_post', $post_id ) ) {5235			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) );5236		}5237		if ( 'publish' === $actual_post['post_status'] && ! current_user_can( 'publish_posts' ) ) {5238			return new IXR_Error( 401, __( 'Sorry, you are not allowed to publish this post.' ) );5239		}5240 5241		$postdata                  = array();5242		$postdata['ID']            = $actual_post['ID'];5243		$postdata['post_content']  = xmlrpc_removepostdata( $content );5244		$postdata['post_title']    = xmlrpc_getposttitle( $content );5245		$postdata['post_category'] = xmlrpc_getpostcategory( $content );5246		$postdata['post_status']   = $actual_post['post_status'];5247		$postdata['post_excerpt']  = $actual_post['post_excerpt'];5248		$postdata['post_status']   = $publish ? 'publish' : 'draft';5249 5250		$result = wp_update_post( $postdata );5251 5252		if ( ! $result ) {5253			return new IXR_Error( 500, __( 'Sorry, the post could not be updated.' ) );5254		}5255		$this->attach_uploads( $actual_post['ID'], $postdata['post_content'] );5256 5257		/**5258		 * Fires after a post has been successfully updated via the XML-RPC Blogger API.5259		 *5260		 * @since 3.4.05261		 *5262		 * @param int   $post_id ID of the updated post.5263		 * @param array $args    An array of arguments for the post to edit.5264		 */5265		do_action( 'xmlrpc_call_success_blogger_editPost', $post_id, $args ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase5266 5267		return true;5268	}

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