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

Timestamp:

02/10/2020 10:01:49 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for the $attr parameter of wp_get_attachment_image().

Props juanfra, Mte90, DrewAPicture, joemcgill, SergeyBiryukov.
Fixes #36661.

File:

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

trunk/src/wp-includes/media.php

@@ -364 +364 @@
  *
  * @param int          $id    Attachment ID.
- * @param string       $alt   Image Description for the alt attribute.
- * @param string       $title Image Description for the title attribute.
+ * @param string       $alt   Image description for the alt attribute.
+ * @param string       $title Image description for the title attribute.
  * @param string       $align Part of the class name for aligning the image.
  * @param string|array $size  Optional. Registered image size to retrieve a tag for. Accepts any
@@ -403 +403 @@
      * @param string       $html  HTML content for the image.
      * @param int          $id    Attachment ID.
-     * @param string       $alt   Alternate text.
-     * @param string       $title Attachment title.
+     * @param string       $alt   Image description for the alt attribute.
+     * @param string       $title Image description for the title attribute.
      * @param string       $align Part of the class name for aligning the image.
      * @param string|array $size  Size of image. Image size or array of width and height values (in that order).
@@ -1000 +1000 @@
  *                                    and height values in pixels (in that order). Default 'thumbnail'.
  * @param bool         $icon          Optional. Whether the image should be treated as an icon. Default false.
- * @param string|array $attr          Optional. Attributes for the image markup. Default empty.
+ * @param string|array $attr {
+ *     Optional. Attributes for the image markup.
+ *
+ *     @type string $src    Image attachment URL.
+ *     @type string $class  CSS class name or space-separated list of classes.
+ *                          Default `attachment-$size_class size-$size_class`,
+ *                          where `$size_class` is the image size being requested.
+ *     @type string $alt    Image description for the alt attribute.
+ *     @type string $srcset The 'srcset' attribute value.
+ *     @type string $sizes  The 'sizes' attribute value.
+ * }
  * @return string HTML img element or empty string on failure.
  */
@@ -1007 +1017 @@
     $image = wp_get_attachment_image_src( $attachment_id, $size, $icon );
     if ( $image ) {
-        list($src, $width, $height) = $image;
-        $hwstring                   = image_hwstring( $width, $height );
-        $size_class                 = $size;
+        list( $src, $width, $height ) = $image;
+        $hwstring                     = image_hwstring( $width, $height );
+        $size_class                   = $size;
         if ( is_array( $size_class ) ) {
             $size_class = join( 'x', $size_class );
@@ -1047 +1057 @@
          *
          * @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.
          * @param string|array $size       Requested size. Image size or array of width and height values