Changeset 35057 for trunk/src/wp-includes/post-template.php

Timestamp:

10/12/2015 04:14:03 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Fix the syntax for marking parameters optional and add defaults in the DocBlock for wp_get_attachment_link().

See #32246.

File:

• trunk/src/wp-includes/post-template.php (modified) (1 diff)

trunk/src/wp-includes/post-template.php

@@ -1406 +1406 @@
  *                                of width and height values in pixels (in that order).
  *                                Default 'thumbnail'.
- * @param bool         $permalink Optional, default is false. Whether to add permalink to image.
- * @param bool         $icon      Optional, default is false. Whether to include icon.
- * @param string|bool  $text      Optional, default is false. If string, then will be link text.
- * @param array|string $attr      Optional. Array or string of attributes.
+ * @param bool         $permalink Optional, Whether to add permalink to image. Default false.
+ * @param bool         $icon      Optional. Whether the attachment is an icon. Default false.
+ * @param string|false $text      Optional. Link text to use. Activated by passing a string, false otherwise.
+ *                                Default false.
+ * @param array|string $attr      Optional. Array or string of attributes. Default empty.
  * @return string HTML content.
  */