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

Timestamp:

11/14/2020 04:33:52 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections and improvements.

See #50768

File:

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

trunk/src/wp-includes/media.php

@@ -43 +43 @@
  * @since 2.5.0
  *
- * @global int   $content_width
+ * @global int $content_width
  *
  * @param int          $width   Width of the image in pixels.
@@ -1082 +1082 @@
          * @since 2.8.0
          *
-         * @param array        $attr       Array of attribute values for the image markup, keyed by attribute name.
+         * @param string[]     $attr       Array of attribute values for the image markup, keyed by attribute name.
          *                                 See wp_get_attachment_image().
          * @param WP_Post      $attachment Image attachment post.
@@ -1110 +1110 @@
      *                                    an array of width and height values in pixels (in that order).
      * @param bool         $icon          Whether the image should be treated as an icon.
-     * @param array        $attr          Array of attribute values for the image markup, keyed by attribute name.
+     * @param string[]     $attr          Array of attribute values for the image markup, keyed by attribute name.
      *                                    See wp_get_attachment_image().
      */
@@ -1238 +1238 @@
  * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
  * @param int    $attachment_id Optional. The image attachment ID. Default 0.
- * @return string|bool          The 'srcset' attribute value. False on error or when only one source exists.
+ * @return string|false The 'srcset' attribute value. False on error or when only one source exists.
  */
 function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) {
@@ -1477 +1477 @@
  * @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.
+ * @return string|false A valid source size value for use in a 'sizes' attribute or false.
  */
 function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null, $attachment_id = 0 ) {