Changeset 53843 for trunk/src/wp-admin/includes/image.php

Timestamp:

08/05/2022 02:05:20 PM (2 years ago)

Author:

audrasjb

Message:

Docs: Various docblock fixes in wp-admin/includes/image.php class, as per docs standards.

See #55646.

File:

• trunk/src/wp-admin/includes/image.php (modified) (15 diffs)

trunk/src/wp-admin/includes/image.php

@@ -72 +72 @@
 
 /**
- * Compare the existing image sub-sizes (as saved in the attachment meta)
- * to the currently registered image sub-sizes, and return the difference.
+ * Compares the existing image sub-sizes (as saved in the attachment meta)
+ * to the currently registered image sub-sizes, and returns the difference.
  *
  * Registered sub-sizes that are larger than the image are skipped.
@@ -729 +729 @@
 
 /**
- * Check if an image belongs to an attachment.
+ * Checks if an image belongs to an attachment.
  *
  * @since 6.1.0
  * @access private
  *
- * @param string $filename     Full path to the image file.
- * @param int   $attachment_id Attachment ID to check.
+ * @param string $filename      Full path to the image file.
+ * @param int    $attachment_id Attachment ID to check.
  * @return bool True if the image belongs to the attachment, false otherwise.
  */
@@ -761 +761 @@
 
 /**
- * Generate attachment meta data and create image sub-sizes for images.
+ * Generates attachment meta data and create image sub-sizes for images.
  *
  * @since 2.1.0
@@ -846 +846 @@
                  *     Information about the newly-uploaded file.
                  *
-                 *     @type string $file  Filename of the newly-uploaded file.
-                 *     @type string $url   URL of the uploaded file.
-                 *     @type string $type  File type.
+                 *     @type string $file Filename of the newly-uploaded file.
+                 *     @type string $url  URL of the uploaded file.
+                 *     @type string $type File type.
                  * }
                  */
@@ -945 +945 @@
 
 /**
- * Convert a fraction string to a decimal.
+ * Converts a fraction string to a decimal.
  *
  * @since 2.5.0
@@ -986 +986 @@
 
 /**
- * Convert the exif date format to a unix timestamp.
+ * Converts the exif date format to a unix timestamp.
  *
  * @since 2.5.0
@@ -1001 +1001 @@
 
 /**
- * Get extended image metadata, exif or iptc as available.
+ * Gets extended image metadata, exif or iptc as available.
  *
  * Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso
@@ -1235 +1235 @@
 
 /**
- * Validate that file is an image.
+ * Validates that file is an image.
  *
  * @since 2.5.0
@@ -1248 +1248 @@
 
 /**
- * Validate that file is suitable for displaying within a web page.
+ * Validates that file is suitable for displaying within a web page.
  *
  * @since 2.5.0
@@ -1279 +1279 @@
 
 /**
- * Load an image resource for editing.
+ * Loads an image resource for editing.
  *
  * @since 2.9.0
@@ -1340 +1340 @@
 
 /**
- * Retrieve the path or URL of an attachment's attached file.
+ * Retrieves the path or URL of an attachment's attached file.
  *
  * If the attached file is not present on the local filesystem (usually due to replication plugins),
@@ -1408 +1408 @@
 
 /**
- * Copy an existing image file.
+ * Copies an existing image file.
  *
  * @since 3.4.0
@@ -1455 +1455 @@
  * @since 6.1.0
  *
- * @param int    $attachment_id  The attachment ID.
+ * @param int    $attachment_id The attachment ID.
  * @return array An array of valid mime types, where the key is the source file mime type and the list of mime types to
  *               generate.
@@ -1467 +1467 @@
 
     /**
-     * Filter the output mime types for a given input mime type and image size.
+     * Filters the output mime types for a given input mime type and image size.
      *
      * @since 6.1.0
      *
-     * @param array  $image_mime_transforms A map with the valid mime transforms where the key is the source file mime type
+     * @param array $image_mime_transforms A map with the valid mime transforms where the key is the source file mime type
      *                                      and the value is one or more mime file types to generate.
-     * @param int    $attachment_id         The ID of the attachment where the hook was dispatched.
+     * @param int   $attachment_id         The ID of the attachment where the hook was dispatched.
      */
     $image_mime_transforms = apply_filters( 'wp_upload_image_mime_transforms', $image_mime_transforms, $attachment_id );
@@ -1490 +1490 @@
 
 /**
- * Extract the primary and additional mime output types for an image from the $image_mime_transforms.
+ * Extracts the primary and additional mime output types for an image from the $image_mime_transforms.
  *
  * @since 6.1.0