Changeset 43642 for trunk/src/wp-admin/includes/media.php

Timestamp:

09/14/2018 01:34:50 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Correct and improve some docblocks.

See #42505

File:

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

trunk/src/wp-admin/includes/media.php

@@ -171 +171 @@
  * @since 2.6.0
  *
- * @param string $html
- * @param integer $id
- * @param string $caption image caption
- * @param string $title image title attribute
- * @param string $align image css alignment property
- * @param string $url image src url
- * @param string $size image size (thumbnail, medium, large, full or added with add_image_size() )
- * @param string $alt image alt attribute
- * @return string
+ * @param string  $html    The image HTML markup to send.
+ * @param integer $id      Image attachment ID.
+ * @param string  $caption Image caption.
+ * @param string  $title   Image title attribute (not used).
+ * @param string  $align   Image CSS alignment property.
+ * @param string  $url     Image source URL (not used).
+ * @param string  $size    Image size (`thumbnail`, `medium`, `large`, `full`, or added with `add_image_size()`) (not used).
+ * @param string  $alt     Image `alt` attribute (not used).
+ * @return string The image HTML markup with caption shortcode.
  */
 function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $alt = '' ) {