Changeset 35672

Timestamp:

11/18/2015 06:52:15 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Properly mark optional parameters as such in the DocBlock and function signature for wp_calculate_image_sizes().

Also updates the subsequent hook docs for the wp_calculate_image_sizes filter.

Props joemcgill.
Fixes #34612.

File:

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

trunk/src/wp-includes/media.php

@@ -1137 +1137 @@
 
 /**
- * Create 'sizes' attribute value for an image.
+ * Creates a 'sizes' attribute value for an image.
  *
  * @since 4.4.0
@@ -1143 +1143 @@
  * @param array|string $size          Image size to retrieve. Accepts any valid image size, or an array
  *                                    of width and height values in pixels (in that order). Default 'medium'.
+ * @param string       $image_src     Optional. The URL to the image file. Default null.
  * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
- * @param int          $attachment_id Optional. Image attachment ID. Either `$image_meta` or `$attachment_id` is needed
- *                                    when using the image size name as argument for `$size`.
- * @param string       $image_src     Optional. The URL to the image file.
- *
+ *                                    Default null.
+ * @param int          $attachment_id Optional. Image attachment ID. Either `$image_meta` or `$attachment_id`
+ *                                    is needed when using the image size name as argument for `$size`. Default 0.
  * @return string|bool A valid source size value for use in a 'sizes' attribute or false.
  */
-function wp_calculate_image_sizes( $size, $image_src, $image_meta, $attachment_id = 0 ) {
+function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null, $attachment_id = 0 ) {
     $width = 0;
 
@@ -1182 +1182 @@
      * @param string       $sizes         A source size value for use in a 'sizes' attribute.
      * @param array|string $size          Requested size. Image size or array of width and height values
-     *                                    in pixels (in that order). Default 'medium'.
-     * @param string       $image_src     The URL to the image file.
-     * @param array        $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
-     * @param int          $attachment_id Image attachment ID of the original image.
+     *                                    in pixels (in that order).
+     * @param string|null  $image_src     The URL to the image file or null.
+     * @param array|null   $image_meta    The image meta data as returned by wp_get_attachment_metadata() or null.
+     * @param int          $attachment_id Image attachment ID of the original image or 0.
      */
     return apply_filters( 'wp_calculate_image_sizes', $sizes, $size, $image_src, $image_meta, $attachment_id );