Changeset 35464 for trunk/src/wp-includes/media.php

Timestamp:

10/30/2015 11:26:44 PM (9 years ago)

Author:

azaozz

Message:

Responsive images:

• Merge wp_image_srcset_attr() into wp_calculate_image_srcset().
• Remove the wp_image_srcset filter.
• Fix the tests for the above changes.

See #34430.

File:

• trunk/src/wp-includes/media.php (modified) (5 diffs)

trunk/src/wp-includes/media.php

@@ -818 +818 @@
             if ( is_array( $image_meta ) ) {
                 $size_array = array( absint( $width ), absint( $height ) );
-                $sources    = wp_calculate_image_srcset( $src, $size_array, $image_meta, $attachment_id );
-                $sizes      = wp_get_attachment_image_sizes( $size_array, $image_meta, $attachment_id );
-
-                if ( count( $sources ) > 1 && ( $sizes || ! empty( $attr['sizes'] ) ) ) {
-                    $attr['srcset'] = wp_image_srcset_attr( $sources, $size_array, $image_meta, $attachment_id );
+                $srcset = wp_calculate_image_srcset( $src, $size_array, $image_meta, $attachment_id );
+                $sizes = wp_get_attachment_image_sizes( $size_array, $image_meta, $attachment_id );
+
+                if ( $srcset && ( $sizes || ! empty( $attr['sizes'] ) ) ) {
+                    $attr['srcset'] = $srcset;
 
                     if ( empty( $attr['sizes'] ) ) {
@@ -944 +944 @@
     );
 
-    // Calculate the sources for the 'srcset'.
-    $sources = wp_calculate_image_srcset( $image_url, $size_array, $image_meta, $attachment_id );
-
-    // Only return a 'srcset' value if there is more than one source.
-    if ( count( $sources ) < 2 ) {
-        return false;
-    }
-
-    return wp_image_srcset_attr( $sources, $size_array, $image_meta, $attachment_id );
-}
-
-
-/**
- * A helper function to concatenate and filter the 'srcset' attribute value.
- *
- * @since 4.4.0
- *
- * @param array   $sources       The array containing image sizes data as returned by 'wp_calculate_image_srcset()'.
- * @param array   $size_array    Array of width and height values in pixels (in that order).
- * @param array   $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
- * @param int     $attachment_id The image attachment ID to pass to the filter.
- * @return string The 'srcset' attribute value.
- */
-function wp_image_srcset_attr( $sources, $size_array, $image_meta, $attachment_id ) {
-    $srcset = '';
-
-    foreach ( $sources as $source ) {
-        $srcset .= $source['url'] . ' ' . $source['value'] . $source['descriptor'] . ', ';
-    }
-
-    /**
-     * Filter the output of 'wp_image_srcset_attr()'.
-     *
-     * @since 4.4.0
-     *
-     * @param string       $srcset        A source set formatted for a 'srcset' attribute.
-     * @param int          $attachment_id Image attachment ID.
-     * @param array|string $size          Image size. Image size name, or an array of width and height
-     *                                    values in pixels (in that order).
-     * @param array        $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
-     */
-    return apply_filters( 'wp_image_srcset', rtrim( $srcset, ', ' ), $attachment_id, $size_array, $image_meta );
+    return wp_calculate_image_srcset( $image_url, $size_array, $image_meta, $attachment_id );
 }
 
@@ -997 +956 @@
  * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
  * @param int    $attachment_id Optional. The image attachment ID to pass to the filter.
- * @return array|bool $sources {
- *     Array image candidate values containing a URL, descriptor type, and
- *     descriptor value. False if none exist.
- *
- *     @type array $values {
- *        @type string $url        An image URL.
- *        @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.
- *     }
- * }
+ * @return string|bool          The 'srcset' attribute value. False on error or when only one source exists.
  */
 function wp_calculate_image_srcset( $image_name, $size_array, $image_meta, $attachment_id = 0 ) {
@@ -1103 +1052 @@
      * @since 4.4.0
      *
-     * @param array        $sources       An array of image URLs and widths.
-     * @param int          $attachment_id Image attachment ID.
-     * @param array|string $size          Image size. Image size name, or an array of width and height
-     *                                    values in pixels (in that order).
-     * @param array        $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
-
-     */
-    return apply_filters( 'wp_calculate_image_srcset', array_values( $sources ), $attachment_id, $size_array, $image_meta );
+     * @param array $sources       An array of image URLs and widths.
+     * @param int   $attachment_id Image attachment ID.
+     * @param array $size_array    Array of width and height values in pixels (in that order).
+     * @param array $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
+
+     */
+    $sources = apply_filters( 'wp_calculate_image_srcset', $sources, $attachment_id, $size_array, $image_meta );
+
+    // Only return a 'srcset' value if there is more than one source.
+    if ( count( $sources ) < 2 ) {
+        return false;
+    }
+
+    $srcset = '';
+
+    foreach ( $sources as $source ) {
+        $srcset .= $source['url'] . ' ' . $source['value'] . $source['descriptor'] . ', ';
+    }
+
+    return rtrim( $srcset, ', ' );
 }
 
@@ -1277 +1238 @@
 
     $size_array = array( $width, $height );
-    $sources = wp_calculate_image_srcset( $src, $size_array, $image_meta, $attachment_id );
-
-    $srcset = $sizes = '';
-    // Only calculate 'srcset' and 'sizes' values if there is more than one source.
-    if ( count( $sources ) > 1 ) {
-        $srcset = wp_image_srcset_attr( $sources, $size_array, $image_meta, $attachment_id );
+    $srcset = wp_calculate_image_srcset( $src, $size_array, $image_meta, $attachment_id );
+
+    if ( $srcset ) {
         $sizes = wp_get_attachment_image_sizes( $size_array, $image_meta, $attachment_id );
     }