Ticket #50835: 50835.diff

src/wp-includes/media.php

@@ -3565 +3565 @@
  * to be JSON-encoded and fit into an Attachment model.
  *
  * @since 3.5.0
- *
+ * 
  * @param int|WP_Post $attachment Attachment ID or object.
- * @return array|void Array of attachment details.
+ * @return array|void {
+ *     Array of attachment details.
+ *     
+ *     @type int $id    The ID of the attachment
+ *     @type string $title    The attachment's title (Usually the slugified file name without the extension)
+ *     @type string $filename    The attachment's file name
+ *     @type string $url    The attachment's direct link (from wp-content)
+ *     @type string $link    The URL to the attachment page
+ *     @type string $alt    Alt text of the attachment
+ *     @type string $author    The Author's ID in string format
+ *     @type string $description    The attachment's description
+ *     @type string $caption    The attachment's caption
+ *     @type string $name    The attachment's name, same as title
+ *     @type string $status    Attachment's 'post' status (Usually 'inherit')
+ *     @type int $uploadedTo    Parent post to which the attachment was uploaded
+ *     @type int $date    Uploaded date, timestamp in milliseconds
+ *     @type int $modified    Last modified, timestamp in milliseconds
+ *     @type int $menuOrder    Post's menu order
+ *     @type string $mime    Attachment's mine (Ex: image/jpeg, application/zip, etc.)
+ *     @type string $type    Attachment type (Usually first-part of mime, eg: image)
+ *     @type string $subtype    Attachment's subtype (Usually the last-part of mine, eg: jpeg / zip)
+ *     @type string $icon    Attachment's icon URL (Eg: /wp-includes/images/media/archive.png)
+ *     @type string $dateFormatted    Formatted Date (Eg: June 29, 2018)
+ *     @type array $nonces    Nounces for update, delete and edit
+ *     @type string $editLink    Link to attachment's edit page
+ *     @type array $meta    Attachment's meta
+ *     @type string $authorName    Author's name
+ *     @type string $uploadedToLink    Link to the attachment's parent post edit page
+ *     @type string $uploadedToTitle    Attachment's parent post title
+ *     @type int $filesizeInBytes    Attachment's filesize in bytes
+ *     @type string $filesizeHumanReadable    Attachment's filesize in human readable format (Eg: 1 MB)
+ *     @type string $context
+ *     @type array $compat    Containing item and meta
+ *     @type int/undefined $height    If the attachment's an image, it represents the height of the image.
+ *     @type int/undefined $width    If the attachment's an image, it represents the width of the image.
+ *     @type string/undefined $orientation    If the attachment's an image, it represents the image orientation (landscape / portrait).
+ *     @type array/undefined $sizes    If the attachment's an image, it contains an array of arrays from the different images sizes: thumb, medium, large, full
+ * }
+ * 
  */
 function wp_prepare_attachment_for_js( $attachment ) {
         $attachment = get_post( $attachment );