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

See #32246.

Built from https://develop.svn.wordpress.org/trunk@35057


git-svn-id: http://core.svn.wordpress.org/trunk@35022 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-10-12 16:15:24 +00:00
parent 4aea111b29
commit 4534f13149
2 changed files with 6 additions and 5 deletions

View File

@ -1405,10 +1405,11 @@ function the_attachment_link( $id = 0, $fullsize = false, $deprecated = false, $
* @param string|array $size Optional. Image size. Accepts any valid image size, or an array * @param string|array $size Optional. Image size. Accepts any valid image size, or an array
* of width and height values in pixels (in that order). * of width and height values in pixels (in that order).
* Default 'thumbnail'. * Default 'thumbnail'.
* @param bool $permalink Optional, default is false. Whether to add permalink to image. * @param bool $permalink Optional, Whether to add permalink to image. Default false.
* @param bool $icon Optional, default is false. Whether to include icon. * @param bool $icon Optional. Whether the attachment is an icon. Default false.
* @param string|bool $text Optional, default is false. If string, then will be link text. * @param string|false $text Optional. Link text to use. Activated by passing a string, false otherwise.
* @param array|string $attr Optional. Array or string of attributes. * Default false.
* @param array|string $attr Optional. Array or string of attributes. Default empty.
* @return string HTML content. * @return string HTML content.
*/ */
function wp_get_attachment_link( $id = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false, $attr = '' ) { function wp_get_attachment_link( $id = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false, $attr = '' ) {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-35056'; $wp_version = '4.4-alpha-35057';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.