WordPress.org

Make WordPress Core

Ticket #11338: 11338.2.patch

File 11338.2.patch, 2.8 KB (added by DrewAPicture, 6 years ago)
  • src/wp-includes/post-template.php

     
    966966 *
    967967 * @since 1.5.0
    968968 *
    969  * @param array|string $args Optional. Override default arguments.
    970  * @return string HTML content, if not displaying.
     969 * @see get_pages()
     970 *
     971 * @param mixed $args {
     972 *     Array or string of arguments. Optional.
     973 *
     974 *     @type int    $child_of     Display only the sub-pages of a single page by ID. Default 0 (all pages).
     975 *     @type string $authors      Comma-separated list of author IDs. Default empty (all authors).
     976 *     @type string $date_format  PHP date format to use for the listed pages. Relies on the 'show_date' parameter.
     977 *                                Default is the value of 'date_format' option.
     978 *     @type int    $depth        Number of levels in the hierarchy of pages to include in the generated list.
     979 *                                Accepts -1 (any depth), 0 (all pages & sub-pages), 1 (top-level pages only),
     980 *                                and n (pages to the given n depth). Default 0.
     981 *     @type bool   $echo         Whether or not to echo the list of pages. Default true.
     982 *     @type string $exclude      Comma-separated list of page IDs to exclude. Default empty.
     983 *     @type array  $include      Comma-separated list of page IDs to include. Default empty.
     984 *     @type string $link_after   Text or HTML to follow the page link label. Default null.
     985 *     @type string $link_before  Text or HTML to precede the page link label. Default null.
     986 *     @type string $post_type    Post type to query for. Default 'page'.
     987 *     @type string $post_status  Comma-separated list of post statuses to include. Default 'publish'.
     988 *     @type string $show_date    Whether to display the page publish or modified date for each page. Accepts
     989 *                                'modified' or any other value. An empty value hides the date. Default empty.
     990 *     @type string $sort_column  Comma-separated list of column names to sort the pages by. Accepts 'post_author',
     991 *                                'post_date', 'post_title', 'post_name', 'post_modified', 'post_modified_gmt',
     992 *                                'menu_order', 'post_parent', 'ID', 'rand', or 'comment_count'. Default 'post_title'.
     993 *     @type string $title_li     List heading. Passing a null or empty value will result in no heading, and the list
     994 *                                will not be wrapped with unordered list `<ul>` tags. Default 'Pages'.
     995 *     @type Walker $walker'      Walker instance to use for listing pages. Default is a Walker_Page instance.
     996 * }
     997 * @return string HTML list of pages.
    971998 */
    972999function wp_list_pages($args = '') {
    9731000        $defaults = array(