W3cubDocs

/WordPress

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)

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' );

		$attachment = get_post( $attachment_id );
		if ( ! $attachment ) {
			return new IXR_Error( 404, __( 'Invalid attachment ID.' ) );
		}

		return $this->_prepare_media_item( $attachment );
	}

Uses

Uses Description
wp-includes/capabilities.php: current_user_can()

Returns whether the current user has the specified capability.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_media_item()

Prepares media item data for return in an XML-RPC object.
wp-includes/class-wp-xmlrpc-server.php: xmlrpc_call

Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::escape()

Escape string or array of strings for database.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::login()

Log user in.

Changelog

Version Description
3.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_xmlrpc_server/wp_getmediaitem