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

See #34612.


git-svn-id: https://develop.svn.wordpress.org/trunk@35592 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-11-09 23:33:06 +00:00
parent 57f41cc1ec
commit a21b20c3f6

View File

@ -1070,18 +1070,19 @@ function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attac
}
/**
* 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.
* }
* }
* @param array $size_array Array of width and height values in pixels (in that order).