Ticket #34464: 34464.diff

src/wp-includes/media.php

@@ -905 +905 @@
                 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 +934 @@
         $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
+         * 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();
@@ -994 +996 @@
          *
          * @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 );
 }
@@ -1030 +1032 @@
          *
          * @param string       $srcset        A source set formated 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 );
 }
@@ -1075 +1077 @@
          *
          * @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 );