wp_xmlrpc_server::wp_getMediaItem() WordPress Method
The wp_xmlrpc_server::wp_getMediaItem() method is used to retrieve a media item from the WordPress media library. This method can be used to retrieve both image and non-image files from the media library.
wp_xmlrpc_server::wp_getMediaItem( array $args ) #
Retrieve a media item by ID
Parameters
- $args
(array)(Required)Method arguments. Note: arguments must be ordered as documented.
- 'blog_id'
(int) (unused) - 'username'
(string) - 'password'
(string) - 'attachment_id'
(int)
- 'blog_id'
Return
(array|IXR_Error) Associative array contains:
- 'date_created_gmt'
- 'parent'
- 'link'
- 'thumbnail'
- 'title'
- 'caption'
- 'description'
- 'metadata'
Source
File: wp-includes/class-wp-xmlrpc-server.php
public function wp_getMediaItem( $args ) { $this->escape( $args ); $username = $args[1]; $password = $args[2]; $attachment_id = (int) $args[3]; $user = $this->login( $username, $password ); if ( ! $user ) { return $this->error; } if ( ! current_user_can( 'upload_files' ) ) { return new IXR_Error( 403, __( 'Sorry, you are not allowed to upload files.' ) ); } /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.getMediaItem', $args, $this ); $attachment = get_post( $attachment_id ); if ( ! $attachment || 'attachment' !== $attachment->post_type ) { return new IXR_Error( 404, __( 'Invalid attachment ID.' ) ); } return $this->_prepare_media_item( $attachment ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |