wp_xmlrpc_server::_prepare_media_item( WP_Post $media_item, string $thumbnail_size = 'thumbnail' ): 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

$media_itemWP_Post

The unprepared media item data.

$thumbnail_sizestringoptional

The image size to use for the thumbnail URL.Default: 'thumbnail'

Return value

array

The prepared media item data.

Performance profile

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

Constant

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

Instructions

63–64

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

Plugin surface

1 hook

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

Called by

4

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below wp_xmlrpc_server::_prepare_media_item()

Further down the call graph this can also reach option, 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 · 1 distinct outcome

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

1. 1
   apply_filters( xmlrpc_prepare_media_item )filterline 1108 (+30 into the body)

   Filters XML-RPC-prepared data for the given media item.

Uses · 6

• wp_get_attachment_url()Retrieves the URL for an attachment.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• get_post_meta()Retrieves a post meta field for the given post ID.
• image_downsize()Scales an image to fit a particular size (such as 'thumb' or 'medium').
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_xmlrpc_server::_convert_date_gmt()Converts a WordPress GMT date string to an IXR_Date object.

Used by · 4

• wp_xmlrpc_server::_prepare_post()Prepares post data for return in an XML-RPC object.
• wp_xmlrpc_server::mw_newMediaObject()Uploads a file, following your settings.
• wp_xmlrpc_server::wp_getMediaItem()Retrieves a media item by ID.
• wp_xmlrpc_server::wp_getMediaLibrary()Retrieves a collection of media library items (or attachments).

Source code

View on Trac ↗View on GitHub ↗

1078	protected function _prepare_media_item( $media_item, $thumbnail_size = 'thumbnail' ) {1079		$_media_item = array(1080			'attachment_id'    => (string) $media_item->ID,1081			'date_created_gmt' => $this->_convert_date_gmt( $media_item->post_date_gmt, $media_item->post_date ),1082			'parent'           => $media_item->post_parent,1083			'link'             => wp_get_attachment_url( $media_item->ID ),1084			'title'            => $media_item->post_title,1085			'caption'          => $media_item->post_excerpt,1086			'description'      => $media_item->post_content,1087			'metadata'         => wp_get_attachment_metadata( $media_item->ID ),1088			'type'             => $media_item->post_mime_type,1089			'alt'              => get_post_meta( $media_item->ID, '_wp_attachment_image_alt', true ),1090		);1091 1092		$thumbnail_src = image_downsize( $media_item->ID, $thumbnail_size );1093		if ( $thumbnail_src ) {1094			$_media_item['thumbnail'] = $thumbnail_src[0];1095		} else {1096			$_media_item['thumbnail'] = $_media_item['link'];1097		}1098 1099		/**1100		 * Filters XML-RPC-prepared data for the given media item.1101		 *1102		 * @since 3.4.01103		 *1104		 * @param array   $_media_item    An array of media item data.1105		 * @param WP_Post $media_item     Media item object.1106		 * @param string  $thumbnail_size Image size.1107		 */1108		return apply_filters( 'xmlrpc_prepare_media_item', $_media_item, $media_item, $thumbnail_size );1109	}

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