Ticket #34464: 34464.1.diff

src/wp-includes/media.php

@@ -879 +879 @@
  *
  *     @type array $values {
  *        @type string $url        An image URL.
- *        @type string $descriptor A width or density descriptor used in a srcset.
+ *        @type string $descriptor A width or density descriptor used in a 'srcset'.
  *        @type int    $value      The descriptor value representing a width or
  *                                 or pixel density.
  *     }
  * }
- *
  */
 function wp_get_attachment_image_srcset_array( $attachment_id, $size = 'medium' ) {
         // Get the intermediate size.
@@ -905 +904 @@
                 return false;
         }
 
-        // Use the URL from the intermediate size or build the url from the metadata.
+        // Use the URL from the intermediate size or build the URL from the metadata.
         if ( ! empty( $image['url'] ) ) {
                 $img_url = $image['url'];
         } else {
@@ -934 +933 @@
         $img_edited = preg_match( '/-e[0-9]{13}/', $img_url, $img_edit_hash );
 
         /**
-         * Filter the maximum width included in a srcset attribute.
+         * Filter the maximum width included in a 'srcset' attribute.
          *
          * @since 4.4.0
          *
-         * @param array|string $size Size of image, either array or string.
+         * @param int          $max_width The maximum width to include in the 'srcset'. Default '1600'.
+         * @param array|string $size      Image size. Image size or an array of width and height
+         *                                values in pixels (in that order).
          */
         $max_srcset_width = apply_filters( 'max_srcset_image_width', 1600, $size );
 
         /*
-         * Set up arrays to hold url candidates and matched image sources so
-         * we can avoid duplicates without looping through the full sources array
+         * Set up arrays to hold URL candidates and matched image sources so
+         * we can avoid duplicates without looping through the full sources array.
          */
         $candidates = $sources = array();
 
@@ -959 +960 @@
                         continue;
                 }
 
-                // Filter out images that are wider than $max_srcset_width.
+                // Filter out images that are wider than `$max_srcset_width`.
                 if ( $max_srcset_width && $img['width'] > $max_srcset_width ) {
                         continue;
                 }
@@ -978 +979 @@
                         // Add the URL to our list of candidates.
                         $candidates[] = $candidate_url;
 
-                        // Add the url, descriptor, and value to the sources array to be returned.
+                        // Add the URL, descriptor, and value to the sources array to be returned.
                         $sources[] = array(
                                 'url'        => $candidate_url,
                                 'descriptor' => 'w',
@@ -994 +995 @@
          *
          * @param array        $sources       An array of image urls and widths.
          * @param int          $attachment_id Attachment ID for image.
-         * @param array|string $size          Image size. Accepts any valid image size, or an array of width and height
-         *                                    values in pixels (in that order). Default 'medium'.
+         * @param array|string $size          Image size. Image size or an array of width and height
+         *                                    values in pixels (in that order).
          */
         return apply_filters( 'wp_get_attachment_image_srcset_array', $sources, $attachment_id, $size );
 }
@@ -1028 +1029 @@
          *
          * @since 4.4.0
          *
-         * @param string       $srcset        A source set formated for a `srcset` attribute.
+         * @param string       $srcset        A source set formatted for a `srcset` attribute.
          * @param int          $attachment_id Attachment ID for image.
-         * @param array|string $size          Image size. Accepts any valid image size, or an array of width and height
-         *                                    values in pixels (in that order). Default 'medium'.
+         * @param array|string $size          Image size. Image size or an array of width and height
+         *                                    values in pixels (in that order).
          */
         return apply_filters( 'wp_get_attachment_image_srcset', rtrim( $srcset, ', ' ), $attachment_id, $size );
 }
@@ -1060 +1061 @@
                 $img_width = $image ? $image['width'] : false;
         }
 
-        // Bail early if $img_width isn't set.
+        // Bail early if `$img_width` isn't set.
         if ( ! $img_width ) {
                 return false;
         }
@@ -1075 +1076 @@
          *
          * @param string       $sizes         A source size value for use in a 'sizes' attribute.
          * @param int          $attachment_id Post ID of the original image.
-         * @param array|string $size          Image size. Accepts any valid image size, or an array of width and height
-         *                                    values in pixels (in that order). Default 'medium'.
+         * @param array|string $size          Image size. Image size or an array of width and height
+         *                                    values in pixels (in that order).
          * @param int          $width         Display width of the image.
          */
         return apply_filters( 'wp_get_attachment_image_sizes', $sizes, $attachment_id, $size, $width );
@@ -1108 +1109 @@
 
         if ( 0 < count( $attachment_ids ) ) {
                 /*
-                 * Warm object caches for use with wp_get_attachment_metadata.
+                 * Warm object caches for use with `wp_get_attachment_metadata`.
                  *
                  * To avoid making a database call for each image, a single query
                  * warms the object cache with the meta information for all images.
@@ -1140 +1141 @@
                 return $image;
         }
 
-        // Parse id, size, width, and height from the `img` element.
+        // Parse ID, size, width, and height from the `img` element.
         $id     = preg_match( '/wp-image-([0-9]+)/i', $image, $match_id     ) ? (int) $match_id[1]     : false;
         $size   = preg_match( '/size-([^\s|"]+)/i',   $image, $match_size   ) ? $match_size[1]         : false;
         $width  = preg_match( '/ width="([0-9]+)"/',  $image, $match_width  ) ? (int) $match_width[1]  : false;
@@ -1160 +1161 @@
         if ( $id && ! $size ) {
                 $meta = wp_get_attachment_metadata( $id );
 
-                // Parse the image src value from the img element.
+                // Parse the image 'src' value from the 'img' element.
                 $src = preg_match( '/src="([^"]+)"/', $image, $match_src ) ? $match_src[1] : false;
 
-                // Return early if the metadata does not exist or the src value is empty.
+                // Return early if the metadata does not exist or the 'src' value is empty.
                 if ( ! $meta || ! $src ) {
                         return $image;
                 }
@@ -1196 +1197 @@
                         // Format the srcset and sizes string and escape attributes.
                         $srcset_and_sizes = sprintf( ' srcset="%s" sizes="%s"', esc_attr( $srcset ), esc_attr( $sizes) );
 
-                        // Add srcset and sizes attributes to the image markup.
+                        // Add 'srcset' and 'sizes' attributes to the image markup.
                         $image = preg_replace( '/<img ([^>]+)[\s?][\/?]>/', '<img $1' . $srcset_and_sizes . ' />', $image );
                 }
         }