From 458ae841eda7461ebb7ef7ba5d2d96a2a83ff737 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Fri, 11 Jul 2014 23:13:15 +0000 Subject: [PATCH] Convert default arguments documentation for `wp_page_menu()` into a hash notation. Props coffee2code for the initial patch/ See #28841. Built from https://develop.svn.wordpress.org/trunk@29112 git-svn-id: http://core.svn.wordpress.org/trunk@28898 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/post-template.php | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/wp-includes/post-template.php b/wp-includes/post-template.php index 00a030250f..4d69705e59 100644 --- a/wp-includes/post-template.php +++ b/wp-includes/post-template.php @@ -1112,23 +1112,22 @@ function wp_list_pages( $args = '' ) { * wp_list_pages()} function. Check that function for more info on those * arguments. * - * - * * @since 2.7.0 * - * @param array|string $args + * @param array|string $args { + * Optional. Arguments to generate a page menu. {@see wp_list_pages()} + * for additional arguments. + * + * @type string $sort_column How to short the list of pages. Accepts post column names. + * Default 'menu_order, post_title'. + * @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|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'. + * } * @return string html menu */ function wp_page_menu( $args = array() ) {