wp_xmlrpc_server::wp_getMediaItem()publicWP 3.1.0

Retrieve a media item by ID

Метод класса: wp_xmlrpc_server{}

Hooks from the method

Return

Array|IXR_Error. Associative array contains:

  • 'date_created_gmt'
  • 'parent'
  • 'link'
  • 'thumbnail'
  • 'title'
  • 'caption'
  • 'description'
  • 'metadata'

Usage

$wp_xmlrpc_server = new wp_xmlrpc_server();
$wp_xmlrpc_server->wp_getMediaItem( $args );
$args(array) (required)

Method arguments. Note: arguments must be ordered as documented.

  • 0(int)
    Blog ID (unused).

  • 1(string)
    Username.

  • 2(string)
    Password.

  • 3(int)
    Attachment ID.

Changelog

Since 3.1.0 Introduced.

Code of wp_xmlrpc_server::wp_getMediaItem() WP 6.1.1

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