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

• $0int

  Post ID.

• $1string

  Username.

• $2string

  Password.

Return value

array|IXR_Error

Performance profile

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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

16–226

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

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

• querycontent queryget_post()called directly
• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()one call below wp_xmlrpc_server::mw_getPost()

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

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

Hooks and filters fired · 1

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

1. 1
   do_action( xmlrpc_call )actionline 6148 (+22 into the body)

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

Uses · 20

• get_post()Retrieves post data given a post ID or post object.
• __()Retrieves the translation of $text.
• current_user_can()Returns whether the current user has the specified capability.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_get_post_categories()Retrieves the list of categories for a post.
• get_cat_name()Retrieves the name of a category from its ID.
• wp_get_post_tags()Retrieves the tags for a post.
• get_extended()Gets extended entry info ().
• get_permalink()Retrieves the full permalink for the current post or post ID.
• get_userdata()Retrieves user info by user ID.
• get_post_format()Retrieve the format slug for a post
• is_sticky()Determines whether a post is sticky.

Source code

View on Trac ↗View on GitHub ↗

6126	public function mw_getPost( $args ) {6127		$this->escape( $args );6128 6129		$post_id  = (int) $args[0];6130		$username = $args[1];6131		$password = $args[2];6132 6133		$user = $this->login( $username, $password );6134		if ( ! $user ) {6135			return $this->error;6136		}6137 6138		$postdata = get_post( $post_id, ARRAY_A );6139		if ( ! $postdata ) {6140			return new IXR_Error( 404, __( 'Invalid post ID.' ) );6141		}6142 6143		if ( ! current_user_can( 'edit_post', $post_id ) ) {6144			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this post.' ) );6145		}6146 6147		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */6148		do_action( 'xmlrpc_call', 'metaWeblog.getPost', $args, $this );6149 6150		if ( '' !== $postdata['post_date'] ) {6151			$post_date         = $this->_convert_date( $postdata['post_date'] );6152			$post_date_gmt     = $this->_convert_date_gmt( $postdata['post_date_gmt'], $postdata['post_date'] );6153			$post_modified     = $this->_convert_date( $postdata['post_modified'] );6154			$post_modified_gmt = $this->_convert_date_gmt( $postdata['post_modified_gmt'], $postdata['post_modified'] );6155 6156			$categories = array();6157			$cat_ids    = wp_get_post_categories( $post_id );6158			foreach ( $cat_ids as $cat_id ) {6159				$categories[] = get_cat_name( $cat_id );6160			}6161 6162			$tagnames = array();6163			$tags     = wp_get_post_tags( $post_id );6164			if ( ! empty( $tags ) ) {6165				foreach ( $tags as $tag ) {6166					$tagnames[] = $tag->name;6167				}6168				$tagnames = implode( ', ', $tagnames );6169			} else {6170				$tagnames = '';6171			}6172 6173			$post = get_extended( $postdata['post_content'] );6174			$link = get_permalink( $postdata['ID'] );6175 6176			// Get the author info.6177			$author = get_userdata( $postdata['post_author'] );6178 6179			$allow_comments = ( 'open' === $postdata['comment_status'] ) ? 1 : 0;6180			$allow_pings    = ( 'open' === $postdata['ping_status'] ) ? 1 : 0;6181 6182			// Consider future posts as published.6183			if ( 'future' === $postdata['post_status'] ) {6184				$postdata['post_status'] = 'publish';6185			}6186 6187			// Get post format.6188			$post_format = get_post_format( $post_id );6189			if ( empty( $post_format ) ) {6190				$post_format = 'standard';6191			}6192 6193			$sticky = false;6194			if ( is_sticky( $post_id ) ) {6195				$sticky = true;6196			}6197 6198			$enclosure = array();6199			foreach ( (array) get_post_custom( $post_id ) as $key => $val ) {6200				if ( 'enclosure' === $key ) {6201					foreach ( (array) $val as $enc ) {6202						$encdata             = explode( "\n", $enc );6203						$enclosure['url']    = trim( htmlspecialchars( $encdata[0] ) );6204						$enclosure['length'] = (int) trim( $encdata[1] );6205						$enclosure['type']   = trim( $encdata[2] );

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