On this page
wp_xmlrpc_server::_prepare_media_item( WP_Post $media_item, string $thumbnail_size = 'thumbnail' ): array
Prepares media item data for return in an XML-RPC object.
Parameters
$media_itemWP_Post Required-
The unprepared media item data.
$thumbnail_sizestring Optional-
The image size to use for the thumbnail URL.
Default:
'thumbnail'
Return
array The prepared media item data.
Source
File: wp-includes/class-wp-xmlrpc-server.php. View all references
protected function _prepare_media_item( $media_item, $thumbnail_size = 'thumbnail' ) {
$_media_item = array(
'attachment_id' => (string) $media_item->ID,
'date_created_gmt' => $this->_convert_date_gmt( $media_item->post_date_gmt, $media_item->post_date ),
'parent' => $media_item->post_parent,
'link' => wp_get_attachment_url( $media_item->ID ),
'title' => $media_item->post_title,
'caption' => $media_item->post_excerpt,
'description' => $media_item->post_content,
'metadata' => wp_get_attachment_metadata( $media_item->ID ),
'type' => $media_item->post_mime_type,
);
$thumbnail_src = image_downsize( $media_item->ID, $thumbnail_size );
if ( $thumbnail_src ) {
$_media_item['thumbnail'] = $thumbnail_src[0];
} else {
$_media_item['thumbnail'] = $_media_item['link'];
}
/**
* Filters XML-RPC-prepared data for the given media item.
*
* @since 3.4.0
*
* @param array $_media_item An array of media item data.
* @param WP_Post $media_item Media item object.
* @param string $thumbnail_size Image size.
*/
return apply_filters( 'xmlrpc_prepare_media_item', $_media_item, $media_item, $thumbnail_size );
}
Hooks
- apply_filters( 'xmlrpc_prepare_media_item',
array $_media_item ,WP_Post $media_item ,string $thumbnail_size ) -
Filters XML-RPC-prepared data for the given media item.
Related
Uses
| Uses | Description |
|---|---|
| wp_get_attachment_url() wp-includes/post.php | Retrieves the URL for an attachment. |
| image_downsize() wp-includes/media.php | Scales an image to fit a particular size (such as ‘thumb’ or ‘medium’). |
| wp_get_attachment_metadata() wp-includes/post.php | Retrieves attachment metadata for attachment ID. |
| wp_xmlrpc_server::_convert_date_gmt() wp-includes/class-wp-xmlrpc-server.php | Convert a WordPress GMT date string to an IXR_Date object. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
Used By
| Used By | Description |
|---|---|
| wp_xmlrpc_server::mw_newMediaObject() wp-includes/class-wp-xmlrpc-server.php | Uploads a file, following your settings. |
| wp_xmlrpc_server::wp_getMediaItem() wp-includes/class-wp-xmlrpc-server.php | Retrieve a media item by ID |
| wp_xmlrpc_server::wp_getMediaLibrary() wp-includes/class-wp-xmlrpc-server.php | Retrieves a collection of media library items (or attachments) |
| wp_xmlrpc_server::_prepare_post() wp-includes/class-wp-xmlrpc-server.php | Prepares post data for return in an XML-RPC object. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_xmlrpc_server/_prepare_media_item