wp_xmlrpc_server::mw_newPost( array $args ): int|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.

• $3array

  Content structure.

• $4intdefault: 0

  Optional. Publish flag. 0 for draft, 1 for publish.

Return value

int|IXR_Error

Performance profile

How much work a call to wp_xmlrpc_server::mw_newPost() 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_user_by().

Scaling

Constant

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

Instructions

168–231

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

Plugin surface

2 hooks

Third-party callbacks on 'xmlrpc_call', 'xmlrpc_call_success_mw_newPost' 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_user_by()one call below wp_xmlrpc_server::mw_newPost()
• optionoption read or writeget_option()one call below wp_xmlrpc_server::mw_newPost()

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

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::mw_newPost() 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_newPost() runs, in this order:

1. 1
   do_action( xmlrpc_call )actionline 5386 (+14 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_newPost )actionline 5694 (+322 into the body)

   Fires after a new post has been successfully created via the XML-RPC MovableType API.

Uses · 22

• do_action()Calls the callback functions that have been added to an action hook.
• __()Retrieves the translation of $text.
• current_user_can()Returns whether the current user has the specified capability.
• get_post_type_object()Retrieves a post type object by name.
• 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_userdata()Retrieves user info by user ID.
• get_default_comment_status()Gets the default comment status for a post type.
• 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].
• get_cat_ID()Retrieves the ID of a category from its name.
• get_default_post_to_edit()Returns default post information to use when populating the "Write Post" form.
• set_post_thumbnail()Sets the post thumbnail (featured image) for the given post.

Used by · 1

• wp_xmlrpc_server::wp_newPage()Creates a new page.

Source code

View on Trac ↗View on GitHub ↗

5372	public function mw_newPost( $args ) {5373		$this->escape( $args );5374 5375		$username       = $args[1];5376		$password       = $args[2];5377		$content_struct = $args[3];5378		$publish        = isset( $args[4] ) ? $args[4] : 0;5379 5380		$user = $this->login( $username, $password );5381		if ( ! $user ) {5382			return $this->error;5383		}5384 5385		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */5386		do_action( 'xmlrpc_call', 'metaWeblog.newPost', $args, $this );5387 5388		$page_template = '';5389		if ( ! empty( $content_struct['post_type'] ) ) {5390			if ( 'page' === $content_struct['post_type'] ) {5391				if ( $publish ) {5392					$cap = 'publish_pages';5393				} elseif ( isset( $content_struct['page_status'] ) && 'publish' === $content_struct['page_status'] ) {5394					$cap = 'publish_pages';5395				} else {5396					$cap = 'edit_pages';5397				}5398				$error_message = __( 'Sorry, you are not allowed to publish pages on this site.' );5399				$post_type     = 'page';5400				if ( ! empty( $content_struct['wp_page_template'] ) ) {5401					$page_template = $content_struct['wp_page_template'];5402				}5403			} elseif ( 'post' === $content_struct['post_type'] ) {5404				if ( $publish ) {5405					$cap = 'publish_posts';5406				} elseif ( isset( $content_struct['post_status'] ) && 'publish' === $content_struct['post_status'] ) {5407					$cap = 'publish_posts';5408				} else {5409					$cap = 'edit_posts';5410				}5411				$error_message = __( 'Sorry, you are not allowed to publish posts on this site.' );5412				$post_type     = 'post';5413			} else {5414				// No other 'post_type' values are allowed here.5415				return new IXR_Error( 401, __( 'Invalid post type.' ) );5416			}5417		} else {5418			if ( $publish ) {5419				$cap = 'publish_posts';5420			} elseif ( isset( $content_struct['post_status'] ) && 'publish' === $content_struct['post_status'] ) {5421				$cap = 'publish_posts';5422			} else {5423				$cap = 'edit_posts';5424			}5425			$error_message = __( 'Sorry, you are not allowed to publish posts on this site.' );5426			$post_type     = 'post';5427		}5428 5429		if ( ! current_user_can( get_post_type_object( $post_type )->cap->create_posts ) ) {5430			return new IXR_Error( 401, __( 'Sorry, you are not allowed to publish posts on this site.' ) );5431		}5432		if ( ! current_user_can( $cap ) ) {5433			return new IXR_Error( 401, $error_message );5434		}5435 5436		// Check for a valid post format if one was given.5437		if ( isset( $content_struct['wp_post_format'] ) ) {5438			$content_struct['wp_post_format'] = sanitize_key( $content_struct['wp_post_format'] );5439			if ( ! array_key_exists( $content_struct['wp_post_format'], get_post_format_strings() ) ) {5440				return new IXR_Error( 404, __( 'Invalid post format.' ) );5441			}5442		}5443 5444		// Let WordPress generate the 'post_name' (slug) unless5445		// one has been provided.5446		$post_name = null;5447		if ( isset( $content_struct['wp_slug'] ) ) {5448			$post_name = $content_struct['wp_slug'];5449		}5450 5451		// Only use a password if one was given.

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.