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

Description

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

• $1string

  Username.

• $2string

  Password.

• $3int

  Post ID.

• $4array

  Extra content arguments.

Return value

true|IXR_Error

True on success, IXR_Error on failure.

Performance profile

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

8–86

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

Plugin surface

1 hook

Third-party callbacks on 'xmlrpc_call' 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::wp_editPost() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_xmlrpc_server::wp_editPost() runs, in this order:

1. 1
   do_action( xmlrpc_call )actionline 1748 (+18 into the body)

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

Uses · 10

• 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.
• mysql2date()Converts given MySQL date string into a different format.
• wp_xmlrpc_server::minimum_args()Checks if the method received at least the minimum number of arguments.
• 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::_convert_date()Converts a WordPress date string to an IXR_Date object.
• wp_xmlrpc_server::_insert_post()Helper method for wp_newPost() and wp_editPost(), containing shared logic.

Source code

View on Trac ↗View on GitHub ↗

1730	public function wp_editPost( $args ) {1731		if ( ! $this->minimum_args( $args, 5 ) ) {1732			return $this->error;1733		}1734 1735		$this->escape( $args );1736 1737		$username       = $args[1];1738		$password       = $args[2];1739		$post_id        = (int) $args[3];1740		$content_struct = $args[4];1741 1742		$user = $this->login( $username, $password );1743		if ( ! $user ) {1744			return $this->error;1745		}1746 1747		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */1748		do_action( 'xmlrpc_call', 'wp.editPost', $args, $this );1749 1750		$post = get_post( $post_id, ARRAY_A );1751 1752		if ( empty( $post['ID'] ) ) {1753			return new IXR_Error( 404, __( 'Invalid post ID.' ) );1754		}1755 1756		if ( isset( $content_struct['if_not_modified_since'] ) ) {1757			// If the post has been modified since the date provided, return an error.1758			if ( mysql2date( 'U', $post['post_modified_gmt'] ) > $content_struct['if_not_modified_since']->getTimestamp() ) {1759				return new IXR_Error( 409, __( 'There is a revision of this post that is more recent.' ) );1760			}1761		}1762 1763		// Convert the date field back to IXR form.1764		$post['post_date'] = $this->_convert_date( $post['post_date'] );1765 1766		/*1767		 * Ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct,1768		 * since _insert_post() will ignore the non-GMT date if the GMT date is set.1769		 */1770		if ( '0000-00-00 00:00:00' === $post['post_date_gmt'] || isset( $content_struct['post_date'] ) ) {1771			unset( $post['post_date_gmt'] );1772		} else {1773			$post['post_date_gmt'] = $this->_convert_date( $post['post_date_gmt'] );1774		}1775 1776		/*1777		 * If the API client did not provide 'post_date', then we must not perpetuate the value that1778		 * was stored in the database, or it will appear to be an intentional edit. Conveying it here1779		 * as if it was coming from the API client will cause an otherwise zeroed out 'post_date_gmt'1780		 * to get set with the value that was originally stored in the database when the draft was created.1781		 */1782		if ( ! isset( $content_struct['post_date'] ) ) {1783			unset( $post['post_date'] );1784		}1785 1786		$this->escape( $post );1787		$merged_content_struct = array_merge( $post, $content_struct );1788 1789		$retval = $this->_insert_post( $user, $merged_content_struct );1790		if ( $retval instanceof IXR_Error ) {1791			return $retval;1792		}1793 1794		return true;1795	}

Changelog

Introduced in 3.4.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.