wppaste
WordPress

wp_xmlrpc_server::wp_editPage( array $args ): array|IXR_Error

Since
2.2.0
Source
wp-includes/class-wp-xmlrpc-server.php:3198
Edits a page.

Compatibility

WordPress
since 2.2.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

    Page ID.
  • $2string

    Username.
  • $3string

    Password.
  • $4string

    Content.
  • $5int

    Publish flag. 0 for draft, 1 for publish.

Return value

array|IXR_Error

Performance profile

How much work a call to wp_xmlrpc_server::wp_editPage() 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
23–55

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

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 · 4 distinct outcomes

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

WhenInstructionsCalls it makes
always23->escape(), ->escape(), ->login()
always43–46->escape(), ->escape(), ->login(), do_action(), get_post(), __()
!current_user_can()51->escape(), ->escape(), ->login(), do_action(), get_post(), current_user_can(), __()
current_user_can()55->escape(), ->escape(), ->login(), do_action(), get_post(), current_user_can(), ->mw_editPost()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 73 instructions, 23–55 executed per call, 4 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

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

  1. do_action( xmlrpc_call )actionline 3215 (+17 into the body)

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

Uses · 8

Source code

	public function wp_editPage( $args ) {		// Items will be escaped in mw_editPost().		$page_id  = (int) $args[1];		$username = $args[2];		$password = $args[3];		$content  = $args[4];		$publish  = $args[5]; 		$escaped_username = $this->escape( $username );		$escaped_password = $this->escape( $password ); 		$user = $this->login( $escaped_username, $escaped_password );		if ( ! $user ) {			return $this->error;		} 		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */		do_action( 'xmlrpc_call', 'wp.editPage', $args, $this ); 		// Get the page data and make sure it is a page.		$actual_page = get_post( $page_id, ARRAY_A );		if ( ! $actual_page || ( 'page' !== $actual_page['post_type'] ) ) {			return new IXR_Error( 404, __( 'Sorry, no such page.' ) );		} 		// Make sure the user is allowed to edit pages.		if ( ! current_user_can( 'edit_page', $page_id ) ) {			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this page.' ) );		} 		// Mark this as content for a page.		$content['post_type'] = 'page'; 		// Arrange args in the way mw_editPost() understands.		$args = array(			$page_id,			$username,			$password,			$content,			$publish,		); 		// Let mw_editPost() do all of the heavy lifting.		return $this->mw_editPost( $args );	}

Changelog

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