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

Edits a page.


Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • int
    Blog ID (unused).
  • 1 int
    Page ID.
  • 2 string
    Username.
  • 3 string
    Password.
  • 4 string
    Content.
  • 5 int
    Publish flag. 0 for draft, 1 for publish.

Top ↑

Return

array|IXR_Error


Top ↑

Source

File: wp-includes/class-wp-xmlrpc-server.php. View all references

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 );
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
2.2.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.