Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-22 17:18:32 +01:00
Code Issues Projects Releases Wiki Activity

Convert default arguments documentation for wp_page_menu() into a hash notation.

Browse Source 
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
This commit is contained in:
Drew Jaynes 2014-07-11 23:13:15 +00:00
parent bcf0dc9ce1
commit 458ae841ed
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
wp-includes/post-template.php
View File

@ -1112,23 +1112,22 @@ function wp_list_pages( $args = '' ) {
* wp_list_pages()} function. Check that function for more info on those
* arguments.
*
* <ul>
* <li><strong>sort_column</strong> - How to sort the list of pages. Defaults
* to 'menu_order, post_title'. Use column for posts table.</li>
* <li><strong>menu_class</strong> - Class to use for the div ID which contains
* the page list. Defaults to 'menu'.</li>
* <li><strong>echo</strong> - Whether to echo list or return it. Defaults to
* echo.</li>
* <li><strong>link_before</strong> - Text before show_home argument text.</li>
* <li><strong>link_after</strong> - Text after show_home argument text.</li>
* <li><strong>show_home</strong> - If you set this argument, then it will
* display the link to the home page. The show_home argument really just needs
* to be set to the value of the text of the link.</li>
* </ul>
*
* @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() ) {