Changeset 35592

Timestamp:

11/09/2015 11:33:06 PM (10 years ago)

Author:

DrewAPicture

Message:

Docs: Fix some formatting in the hook doc for the wp_calculate_image_srcset filter and clarify the summary.

See #34612.

File:

• trunk/src/wp-includes/media.php (modified) (1 diff)

trunk/src/wp-includes/media.php

@@ -1071 +1071 @@
 
     /**
-     * Filter the output of 'wp_calculate_image_srcset()'.
+     * Filter an image's 'srcset' sources.
      *
      * @since 4.4.0
      *
      * @param array  $sources {
-     *     An array of sources to include in the 'srcset'.
+     *     One or more arrays of source data to include in the 'srcset'.
      *
      *     @type type array $width {
-     *          @type type string $url        The URL of an image source in the .
-     *          @type type string $descriptor The descriptor type used in the image candidate string, either 'w' or 'x'.
-     *          @type type int    $value      The source width, if paired with a 'w' descriptor or a pixel density value
-     *                                        if paired with an 'x' descriptor.
+     *          @type type string $url        The URL of an image source.
+     *          @type type string $descriptor The descriptor type used in the image candidate string,
+     *                                        either 'w' or 'x'.
+     *          @type type int    $value      The source width, if paired with a 'w' descriptor or a
+     *                                        pixel density value if paired with an 'x' descriptor.
      *     }
      * }