From 9098b45e530077aadb9bc802770df93ed46fe38c Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sat, 10 May 2014 08:02:14 +0000 Subject: [PATCH] Add inline documentation of the default arguments for `wp_list_pages()`. Props garza for the initial patches. Fixes #11338. Built from https://develop.svn.wordpress.org/trunk@28357 git-svn-id: http://core.svn.wordpress.org/trunk@28185 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/post-template.php | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/wp-includes/post-template.php b/wp-includes/post-template.php index 0f07020f6c..c4a84f790c 100644 --- a/wp-includes/post-template.php +++ b/wp-includes/post-template.php @@ -966,10 +966,37 @@ function wp_dropdown_pages($args = '') { * * @since 1.5.0 * - * @param array|string $args Optional. Override default arguments. - * @return string HTML content, if not displaying. + * @see get_pages() + * + * @param array|string $args { + * Array or string of arguments. Optional. + * + * @type int $child_of Display only the sub-pages of a single page by ID. Default 0 (all pages). + * @type string $authors Comma-separated list of author IDs. Default empty (all authors). + * @type string $date_format PHP date format to use for the listed pages. Relies on the 'show_date' parameter. + * Default is the value of 'date_format' option. + * @type int $depth Number of levels in the hierarchy of pages to include in the generated list. + * Accepts -1 (any depth), 0 (all pages), 1 (top-level pages only), and n (pages to + * the given n depth). Default 0. + * @type bool $echo Whether or not to echo the list of pages. Default true. + * @type string $exclude Comma-separated list of page IDs to exclude. Default empty. + * @type array $include Comma-separated list of page IDs to include. Default empty. + * @type string $link_after Text or HTML to follow the page link label. Default null. + * @type string $link_before Text or HTML to precede the page link label. Default null. + * @type string $post_type Post type to query for. Default 'page'. + * @type string $post_status Comma-separated list of post statuses to include. Default 'publish'. + * @type string $show_date Whether to display the page publish or modified date for each page. Accepts + * 'modified' or any other value. An empty value hides the date. Default empty. + * @type string $sort_column Comma-separated list of column names to sort the pages by. Accepts 'post_author', + * 'post_date', 'post_title', 'post_name', 'post_modified', 'post_modified_gmt', + * 'menu_order', 'post_parent', 'ID', 'rand', or 'comment_count'. Default 'post_title'. + * @type string $title_li List heading. Passing a null or empty value will result in no heading, and the list + * will not be wrapped with unordered list `