WordPress.org

Make WordPress Core

Changeset 28899


Ignore:
Timestamp:
06/29/2014 06:55:45 PM (5 years ago)
Author:
DrewAPicture
Message:

Re-document default arguments in wp_link_pages() using the hash-notation style.

Props taylorde.
Fixes #28680.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/post-template.php

    r28880 r28899  
    715715 * Quicktag one or more times). This tag must be within The Loop.
    716716 *
    717  * The defaults for overwriting are:
    718  * 'before' - Default is '<p> Pages:' (string). The html or text to prepend to
    719  *      each bookmarks.
    720  * 'after' - Default is '</p>' (string). The html or text to append to each
    721  *      bookmarks.
    722  * 'link_before' - Default is '' (string). The html or text to prepend to each
    723  *      Pages link inside the <a> tag. Also prepended to the current item, which
    724  *      is not linked.
    725  * 'link_after' - Default is '' (string). The html or text to append to each
    726  *      Pages link inside the <a> tag. Also appended to the current item, which
    727  *      is not linked.
    728  * 'next_or_number' - Default is 'number' (string). Indicates whether page
    729  *      numbers should be used. Valid values are number and next.
    730  * 'separator' - Default is ' ' (string). Text used between pagination links.
    731  * 'nextpagelink' - Default is 'Next Page' (string). Text for link to next page.
    732  *      of the bookmark.
    733  * 'previouspagelink' - Default is 'Previous Page' (string). Text for link to
    734  *      previous page, if available.
    735  * 'pagelink' - Default is '%' (String).Format string for page numbers. The % in
    736  *      the parameter string will be replaced with the page number, so Page %
    737  *      generates "Page 1", "Page 2", etc. Defaults to %, just the page number.
    738  * 'echo' - Default is 1 (integer). When not 0, this triggers the HTML to be
    739  *      echoed and then returned.
    740  *
    741717 * @since 1.2.0
    742718 *
    743  * @param string|array $args Optional. Overwrite the defaults.
     719 * @param string|array $args {
     720 *     Optional. Array or string of default arguments.
     721 *
     722 *     @type string       $before           HTML or text to prepend to each link. Default is '<p> Pages:'.
     723 *     @type string       $after            HTML or text to append to each link. Default is '</p>'.
     724 *     @type string       $link_before      HTML or text to prepend to each link, inside the <a> tag.
     725 *                                          Also prepended to the current item, which is not linked. Default empty.
     726 *     @type string       $link_after       HTML or text to append to each Pages link inside the <a> tag.
     727 *                                          Also appended to the current item, which is not linked. Default empty.
     728 *     @type string       $next_or_number   Indicates whether page numbers should be used. Valid values are number
     729 *                                          and next. Default is 'number'.
     730 *     @type string       $separator        Text between pagination links. Default is ' '.
     731 *     @type string       $nextpagelink     Link text for the next page link, if available. Default is 'Next Page'.
     732 *     @type string       $previouspagelink Link text for the previous page link, if available. Default is 'Previous Page'.
     733 *     @type string       $pagelink         Format string for page numbers. The % in the parameter string will be
     734 *                                          replaced with the page number, so 'Page %' generates "Page 1", "Page 2", etc.
     735 *                                          Defaults to '%', just the page number.
     736 *     @type int|bool     $echo             Whether to echo or not. Accepts 1|true or 0|false. Default 1|true.
     737 * }
    744738 * @return string Formatted output in HTML.
    745739 */
Note: See TracChangeset for help on using the changeset viewer.