Add inline documentation of the default arguments for `wp_list_pages()`.
Props garza for the initial patches. Fixes #11338. git-svn-id: https://develop.svn.wordpress.org/trunk@28357 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
f3d9e1ed7e
commit
cb5852a813
|
@ -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 `<ul>` tags. Default 'Pages'.
|
||||
* @type Walker $walker Walker instance to use for listing pages. Default empty (Walker_Page).
|
||||
* }
|
||||
* @return string HTML list of pages.
|
||||
*/
|
||||
function wp_list_pages($args = '') {
|
||||
function wp_list_pages( $args = '' ) {
|
||||
$defaults = array(
|
||||
'depth' => 0, 'show_date' => '',
|
||||
'date_format' => get_option('date_format'),
|
||||
|
|
Loading…
Reference in New Issue