From 45c6094dcea8d62f8aea6697edf67f602f0860a0 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Wed, 16 Sep 2015 16:46:08 +0000 Subject: [PATCH] Docs: Update the DocBlock for `wp_page_menu()` to include `'before'`, `'after'`, and `'walker'` arguments added in [34200]. Align the `$defaults` array and include the default value for `'show_home'`. Props stevegrunwell. Fixes #11095. git-svn-id: https://develop.svn.wordpress.org/trunk@34243 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/post-template.php | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/src/wp-includes/post-template.php b/src/wp-includes/post-template.php index 3f8beab86b..b296464836 100644 --- a/src/wp-includes/post-template.php +++ b/src/wp-includes/post-template.php @@ -1187,6 +1187,7 @@ function wp_list_pages( $args = '' ) { * arguments. * * @since 2.7.0 + * @since 4.4.0 Added `$before`, `$after`, and `$walker` arguments. * * @param array|string $args { * Optional. Arguments to generate a page menu. See wp_list_pages() for additional arguments. @@ -1196,23 +1197,27 @@ function wp_list_pages( $args = '' ) { * @type string $menu_class Class to use for the div ID containing the page list. Default 'menu'. * @type bool $echo Whether to echo the list or return it. Accepts true (echo) or false (return). * Default true. - * @type string $link_before The HTML or text to prepend to $show_home text. Default empty. - * @type string $link_after The HTML or text to append to $show_home text. Default empty. * @type int|bool|string $show_home Whether to display the link to the home page. Can just enter the text * you'd like shown for the home link. 1|true defaults to 'Home'. + * @type string $link_before The HTML or text to prepend to $show_home text. Default empty. + * @type string $link_after The HTML or text to append to $show_home text. Default empty. + * @type string $before The HTML or text to prepend to the menu. Default is ''. + * @type Walker $walker Walker instance to use for listing pages. Default empty (Walker_Page). * } * @return string|void HTML menu */ function wp_page_menu( $args = array() ) { $defaults = array( 'sort_column' => 'menu_order, post_title', - 'menu_class' => 'menu', - 'echo' => true, + 'menu_class' => 'menu', + 'echo' => true, + 'show_home' => false, 'link_before' => '', - 'link_after' => '', - 'before' => '', - 'walker' => '' + 'link_after' => '', + 'before' => '', + 'walker' => '', ); $args = wp_parse_args( $args, $defaults );