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

Timestamp:

01/18/2020 12:52:28 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve comments in some wp-admin files per the documentation standards.

Props passoniate.
Fixes #49215, #49216.

File:

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

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

@@ -25 +25 @@
 function wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {
     $src_file = $src;
-    if ( is_numeric( $src ) ) { // Handle int as attachment ID
+    if ( is_numeric( $src ) ) { // Handle int as attachment ID.
         $src_file = get_attached_file( $src );
 
@@ -118 +118 @@
     }
 
-    // Remove sizes that already exist. Only checks for matching "size names".
-    // It is possible that the dimensions for a particular size name have changed.
-    // For example the user has changed the values on the Settings -> Media screen.
-    // However we keep the old sub-sizes with the previous dimensions
-    // as the image may have been used in an older post.
+    /*
+     * Remove sizes that already exist. Only checks for matching "size names".
+     * It is possible that the dimensions for a particular size name have changed.
+     * For example the user has changed the values on the Settings -> Media screen.
+     * However we keep the old sub-sizes with the previous dimensions
+     * as the image may have been used in an older post.
+     */
     $missing_sizes = array_diff_key( $possible_sizes, $image_meta['sizes'] );
 
@@ -230 +232 @@
     }
 
-    // Default image meta
+    // Default image meta.
     $image_meta = array(
         'width'  => $imagesize[0],
@@ -319 +321 @@
             }
 
-            // Rotate the image
+            // Rotate the image.
             $rotated = $editor->maybe_exif_rotate();
 
@@ -340 +342 @@
     }
 
-    // Initial save of the new metadata.
-    // At this point the file was uploaded and moved to the uploads directory
-    // but the image sub-sizes haven't been created yet and the `sizes` array is empty.
+    /*
+     * Initial save of the new metadata.
+     * At this point the file was uploaded and moved to the uploads directory
+     * but the image sub-sizes haven't been created yet and the `sizes` array is empty.
+     */
     wp_update_attachment_metadata( $attachment_id, $image_meta );
 
@@ -387 +391 @@
     if ( isset( $image_meta['sizes'] ) && is_array( $image_meta['sizes'] ) ) {
         foreach ( $image_meta['sizes'] as $size_name => $size_meta ) {
-            // Only checks "size name" so we don't override existing images even if the dimensions
-            // don't match the currently defined size with the same name.
-            // To change the behavior, unset changed/mismatched sizes in the `sizes` array in image meta.
+            /*
+             * Only checks "size name" so we don't override existing images even if the dimensions
+             * don't match the currently defined size with the same name.
+             * To change the behavior, unset changed/mismatched sizes in the `sizes` array in image meta.
+             */
             if ( array_key_exists( $size_name, $new_sizes ) ) {
                 unset( $new_sizes[ $size_name ] );
@@ -403 +409 @@
     }
 
-    // Sort the image sub-sizes in order of priority when creating them.
-    // This ensures there is an appropriate sub-size the user can access immediately
-    // even when there was an error and not all sub-sizes were created.
+    /*
+     * Sort the image sub-sizes in order of priority when creating them.
+     * This ensures there is an appropriate sub-size the user can access immediately
+     * even when there was an error and not all sub-sizes were created.
+     */
     $priority = array(
         'medium'       => null,
@@ -734 +742 @@
             }
 
-            if ( ! empty( $iptc['2#110'][0] ) ) { // credit
+            if ( ! empty( $iptc['2#110'][0] ) ) { // Credit.
                 $meta['credit'] = trim( $iptc['2#110'][0] );
-            } elseif ( ! empty( $iptc['2#080'][0] ) ) { // creator / legacy byline
+            } elseif ( ! empty( $iptc['2#080'][0] ) ) { // Creator / legacy byline.
                 $meta['credit'] = trim( $iptc['2#080'][0] );
             }
 
-            if ( ! empty( $iptc['2#055'][0] ) && ! empty( $iptc['2#060'][0] ) ) { // created date and time
+            if ( ! empty( $iptc['2#055'][0] ) && ! empty( $iptc['2#060'][0] ) ) { // Created date and time.
                 $meta['created_timestamp'] = strtotime( $iptc['2#055'][0] . ' ' . $iptc['2#060'][0] );
             }
 
-            if ( ! empty( $iptc['2#116'][0] ) ) { // copyright
+            if ( ! empty( $iptc['2#116'][0] ) ) { // Copyright.
                 $meta['copyright'] = trim( $iptc['2#116'][0] );
             }
 
-            if ( ! empty( $iptc['2#025'][0] ) ) { // keywords array
+            if ( ! empty( $iptc['2#025'][0] ) ) { // Keywords array.
                 $meta['keywords'] = array_values( $iptc['2#025'] );
             }
@@ -774 +782 @@
 
             if ( empty( $meta['title'] ) && $description_length < 80 ) {
-                // Assume the title is stored in ImageDescription
+                // Assume the title is stored in ImageDescription.
                 $meta['title'] = trim( $exif['ImageDescription'] );
             }