wp_xmlrpc_server::wp_newPost( array $args ): int|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: top-level arguments must be ordered as documented.

• $0int

  Blog ID (unused).

• $1string

  Username.

• $2string

  Password.

• $3arraydefault: 'post'

  { Content struct for adding a new post. See wp_insert_post() for information on additional post fields @type string $post_type Post type.

• $post_statusstringdefault: 'draft' @type string $post_title Post title

  Post status.

• $post_authorint

  Post author ID.

• $post_excerptstring

  Post excerpt.

• $post_contentstring

  Post content.

• $post_date_gmtstring

  Post date in GMT.

• $post_datestring

  Post date.

• $post_passwordstring

  Post password (20-character limit).

• $comment_statusstring

  Post comment enabled status. Accepts 'open' or 'closed'.

• $ping_statusstring

  Post ping status. Accepts 'open' or 'closed'.

• $stickybool

  Whether the post should be sticky. Automatically false if $post_status is 'private'.

• $post_thumbnailint

  ID of an image to use as the post thumbnail/featured image.

• $custom_fieldsarray

  Array of meta key/value pairs to add to the post.

• $termsarray

  Associative array with taxonomy names as keys and arrays of term IDs as values.

• $terms_namesarray

  Associative array with taxonomy names as keys and arrays of term names as values.

• $enclosurearray

  { Array of feed enclosure data to add to post meta.

• $urlstring

  URL for the feed enclosure.

• $lengthint

  Size in bytes of the enclosure.

• $typestring

  Mime-type for the enclosure. } }

Return value

int|IXR_Error

Post ID on success, IXR_Error instance otherwise.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

8–60

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

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

What one call costs · 5 distinct outcomes

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

1. 1
   do_action( xmlrpc_call )actionline 1358 (+34 into the body)

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

Uses · 6

• do_action()Calls the callback functions that have been added to an action hook.
• 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.
• 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 ↗

1324	public function wp_newPost( $args ) {1325		if ( ! $this->minimum_args( $args, 4 ) ) {1326			return $this->error;1327		}1328 1329		$this->escape( $args );1330 1331		$username       = $args[1];1332		$password       = $args[2];1333		$content_struct = $args[3];1334 1335		$user = $this->login( $username, $password );1336		if ( ! $user ) {1337			return $this->error;1338		}1339 1340		// Convert the date field back to IXR form.1341		if ( isset( $content_struct['post_date'] ) && ! ( $content_struct['post_date'] instanceof IXR_Date ) ) {1342			$content_struct['post_date'] = $this->_convert_date( $content_struct['post_date'] );1343		}1344 1345		/*1346		 * Ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct,1347		 * since _insert_post() will ignore the non-GMT date if the GMT date is set.1348		 */1349		if ( isset( $content_struct['post_date_gmt'] ) && ! ( $content_struct['post_date_gmt'] instanceof IXR_Date ) ) {1350			if ( '0000-00-00 00:00:00' === $content_struct['post_date_gmt'] || isset( $content_struct['post_date'] ) ) {1351				unset( $content_struct['post_date_gmt'] );1352			} else {1353				$content_struct['post_date_gmt'] = $this->_convert_date( $content_struct['post_date_gmt'] );1354			}1355		}1356 1357		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */1358		do_action( 'xmlrpc_call', 'wp.newPost', $args, $this );1359 1360		unset( $content_struct['ID'] );1361 1362		return $this->_insert_post( $user, $content_struct );1363	}

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