From 5f08eed052e0af6d26daf85cd6bc2d33c4a9c56e Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 29 Jun 2014 18:56:16 +0000 Subject: [PATCH] Re-document default arguments in `wp_link_pages()` using the hash-notation style. Props taylorde. Fixes #28680. Built from https://develop.svn.wordpress.org/trunk@28899 git-svn-id: http://core.svn.wordpress.org/trunk@28698 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/post-template.php | 44 +++++++++++++++-------------------- 1 file changed, 19 insertions(+), 25 deletions(-) diff --git a/wp-includes/post-template.php b/wp-includes/post-template.php index 94fda7dec2..ee59727278 100644 --- a/wp-includes/post-template.php +++ b/wp-includes/post-template.php @@ -714,33 +714,27 @@ function post_password_required( $post = null ) { * Displays page links for paginated posts (i.e. includes the . * Quicktag one or more times). This tag must be within The Loop. * - * The defaults for overwriting are: - * 'before' - Default is '

Pages:' (string). The html or text to prepend to - * each bookmarks. - * 'after' - Default is '

' (string). The html or text to append to each - * bookmarks. - * 'link_before' - Default is '' (string). The html or text to prepend to each - * Pages link inside the tag. Also prepended to the current item, which - * is not linked. - * 'link_after' - Default is '' (string). The html or text to append to each - * Pages link inside the tag. Also appended to the current item, which - * is not linked. - * 'next_or_number' - Default is 'number' (string). Indicates whether page - * numbers should be used. Valid values are number and next. - * 'separator' - Default is ' ' (string). Text used between pagination links. - * 'nextpagelink' - Default is 'Next Page' (string). Text for link to next page. - * of the bookmark. - * 'previouspagelink' - Default is 'Previous Page' (string). Text for link to - * previous page, if available. - * 'pagelink' - Default is '%' (String).Format string for page numbers. The % in - * the parameter string will be replaced with the page number, so Page % - * generates "Page 1", "Page 2", etc. Defaults to %, just the page number. - * 'echo' - Default is 1 (integer). When not 0, this triggers the HTML to be - * echoed and then returned. - * * @since 1.2.0 * - * @param string|array $args Optional. Overwrite the defaults. + * @param string|array $args { + * Optional. Array or string of default arguments. + * + * @type string $before HTML or text to prepend to each link. Default is '

Pages:'. + * @type string $after HTML or text to append to each link. Default is '

'. + * @type string $link_before HTML or text to prepend to each link, inside the tag. + * Also prepended to the current item, which is not linked. Default empty. + * @type string $link_after HTML or text to append to each Pages link inside the tag. + * Also appended to the current item, which is not linked. Default empty. + * @type string $next_or_number Indicates whether page numbers should be used. Valid values are number + * and next. Default is 'number'. + * @type string $separator Text between pagination links. Default is ' '. + * @type string $nextpagelink Link text for the next page link, if available. Default is 'Next Page'. + * @type string $previouspagelink Link text for the previous page link, if available. Default is 'Previous Page'. + * @type string $pagelink Format string for page numbers. The % in the parameter string will be + * replaced with the page number, so 'Page %' generates "Page 1", "Page 2", etc. + * Defaults to '%', just the page number. + * @type int|bool $echo Whether to echo or not. Accepts 1|true or 0|false. Default 1|true. + * } * @return string Formatted output in HTML. */ function wp_link_pages( $args = '' ) {