Changeset 34243

Timestamp:

09/16/2015 04:46:08 PM (10 years ago)

Author:

SergeyBiryukov

Message:

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.

File:

• trunk/src/wp-includes/post-template.php (modified) (3 diffs)

trunk/src/wp-includes/post-template.php

@@ -1188 +1188 @@
  *
  * @since 2.7.0
+ * @since 4.4.0 Added `$before`, `$after`, and `$walker` arguments.
  *
  * @param array|string $args {
@@ -1197 +1198 @@
  *     @type bool            $echo        Whether to echo the list or return it. Accepts true (echo) or false (return).
  *                                        Default true.
+ *     @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 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          $before      The HTML or text to prepend to the menu. Default is '<ul>'.
+ *     @type string          $after       The HTML or text to append to the menu. Default is '</ul>'.
+ *     @type Walker          $walker      Walker instance to use for listing pages. Default empty (Walker_Page).
  * }
  * @return string|void HTML menu
@@ -1207 +1211 @@
     $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' => '<ul>',
-        'after' => '</ul>',
-        'walker' => ''
+        'link_after'  => '',
+        'before'      => '<ul>',
+        'after'       => '</ul>',
+        'walker'      => '',
     );
     $args = wp_parse_args( $args, $defaults );