wp_xmlrpc_server::_prepare_post( array $post, array $fields ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$postarray

The unprepared post data.

$fieldsarray

The subset of post type fields to return.

Return value

array

The prepared post data.

Performance profile

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

125–220

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

Plugin surface

1 hook

Third-party callbacks on 'xmlrpc_prepare_post' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

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

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

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( xmlrpc_prepare_post )filterline 1007 (+90 into the body)

   Filters XML-RPC-prepared date for the given post.

Uses · 15

• get_permalink()Retrieves the full permalink for the current post or post ID.
• is_sticky()Determines whether a post is sticky.
• get_post_thumbnail_id()Retrieves the post thumbnail ID.
• current_theme_supports()Checks a theme's support for a given feature.
• get_post()Retrieves post data given a post ID or post object.
• get_post_format()Retrieve the format slug for a post
• get_object_taxonomies()Returns the names or objects of the taxonomies which are registered for the requested object or object type, such as a post object or post type name.
• wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.
• get_post_meta()Retrieves a post meta field for the given post ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_xmlrpc_server::_convert_date()Converts a WordPress date string to an IXR_Date object.
• wp_xmlrpc_server::_convert_date_gmt()Converts a WordPress GMT date string to an IXR_Date object.

Used by · 3

• wp_xmlrpc_server::wp_getPost()Retrieves a post.
• wp_xmlrpc_server::wp_getPosts()Retrieves posts.
• wp_xmlrpc_server::wp_getRevisions()Retrieves revisions for a specific post.

Source code

View on Trac ↗View on GitHub ↗

917	protected function _prepare_post( $post, $fields ) {918		// Holds the data for this post. built up based on $fields.919		$_post = array( 'post_id' => (string) $post['ID'] );920 921		// Prepare common post fields.922		$post_fields = array(923			'post_title'        => $post['post_title'],924			'post_date'         => $this->_convert_date( $post['post_date'] ),925			'post_date_gmt'     => $this->_convert_date_gmt( $post['post_date_gmt'], $post['post_date'] ),926			'post_modified'     => $this->_convert_date( $post['post_modified'] ),927			'post_modified_gmt' => $this->_convert_date_gmt( $post['post_modified_gmt'], $post['post_modified'] ),928			'post_status'       => $post['post_status'],929			'post_type'         => $post['post_type'],930			'post_name'         => $post['post_name'],931			'post_author'       => $post['post_author'],932			'post_password'     => $post['post_password'],933			'post_excerpt'      => $post['post_excerpt'],934			'post_content'      => $post['post_content'],935			'post_parent'       => (string) $post['post_parent'],936			'post_mime_type'    => $post['post_mime_type'],937			'link'              => get_permalink( $post['ID'] ),938			'guid'              => $post['guid'],939			'menu_order'        => (int) $post['menu_order'],940			'comment_status'    => $post['comment_status'],941			'ping_status'       => $post['ping_status'],942			'sticky'            => ( 'post' === $post['post_type'] && is_sticky( $post['ID'] ) ),943		);944 945		// Thumbnail.946		$post_fields['post_thumbnail'] = array();947		$thumbnail_id                  = get_post_thumbnail_id( $post['ID'] );948		if ( $thumbnail_id ) {949			$thumbnail_size                = current_theme_supports( 'post-thumbnail' ) ? 'post-thumbnail' : 'thumbnail';950			$post_fields['post_thumbnail'] = $this->_prepare_media_item( get_post( $thumbnail_id ), $thumbnail_size );951		}952 953		// Consider future posts as published.954		if ( 'future' === $post_fields['post_status'] ) {955			$post_fields['post_status'] = 'publish';956		}957 958		// Fill in blank post format.959		$post_fields['post_format'] = get_post_format( $post['ID'] );960		if ( empty( $post_fields['post_format'] ) ) {961			$post_fields['post_format'] = 'standard';962		}963 964		// Merge requested $post_fields fields into $_post.965		if ( in_array( 'post', $fields, true ) ) {966			$_post = array_merge( $_post, $post_fields );967		} else {968			$requested_fields = array_intersect_key( $post_fields, array_flip( $fields ) );969			$_post            = array_merge( $_post, $requested_fields );970		}971 972		$all_taxonomy_fields = in_array( 'taxonomies', $fields, true );973 974		if ( $all_taxonomy_fields || in_array( 'terms', $fields, true ) ) {975			$post_type_taxonomies = get_object_taxonomies( $post['post_type'], 'names' );976			$terms                = wp_get_object_terms( $post['ID'], $post_type_taxonomies );977			$_post['terms']       = array();978			foreach ( $terms as $term ) {979				$_post['terms'][] = $this->_prepare_term( $term );980			}981		}982 983		if ( in_array( 'custom_fields', $fields, true ) ) {984			$_post['custom_fields'] = $this->get_custom_fields( $post['ID'] );985		}986 987		if ( in_array( 'enclosure', $fields, true ) ) {988			$_post['enclosure'] = array();989			$enclosures         = (array) get_post_meta( $post['ID'], 'enclosure' );990			if ( ! empty( $enclosures ) ) {991				$encdata                      = explode( "\n", $enclosures[0] );992				$_post['enclosure']['url']    = trim( htmlspecialchars( $encdata[0] ) );993				$_post['enclosure']['length'] = (int) trim( $encdata[1] );994				$_post['enclosure']['type']   = trim( $encdata[2] );995			}996		}

Changelog

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.