当前浏览:首页 / WordPress函数 / wp_page_menu()

wp_page_menu( array|string $args = array() )

显示或检索带有可选主页链接的页面列表

menumore...

pagemore...


描述

下面列出了参数,部分参数用于wp_list_pages()函数。有关这些参数的更多信息,请查看该函数。


参数

$args

(array|string)(可选) 用于生成页面菜单的参数数组或字符串。有关其他参数,请参见wp_list_pages()

  • 'sort_column'
    (string) 如何对页面列表排序。接受post列名。默认值为'menu_order, post_title'。
  • 'menu_id'
    (string) 包含页面列表的div的ID。默认值为空字符串。
  • 'menu_class'
    (string) 包含页面列表的元素的类。默认值为'menu'。
  • 'container'
    (string) 包含页面列表的容器元素。默认值为'div'。
  • 'echo'
    (bool) 是回显列表还是返回列表。接受true(echo)或false(return)。默认为true。
  • 'show_home'
    (int|bool|string) 是否显示指向主页的链接。您只需输入希望在主页链接中显示的文本即可。1|true 默认为'Home'。
  • 'link_before'
    (string) 要前置到$show_home文本的HTML或文本。
  • 'link_after'
    (string) 要附加到$show_home文本的HTML或文本。
  • 'before'
    (string) 要在菜单前添加的HTML或文本。默认值为<ul>
  • 'after'
    (string) 要附加到菜单的HTML或文本。默认值为</ul>
  • 'item_spacing'
    (string) 是否在菜单的HTML中保留空白。接受'preserve'或'discard'。默认值为'discard'。
  • 'walker'
    (Walker) Walker实例,用于列出页面。默认为空,导致使用Walker_Page实例。

默认值: array()


返回

(void|string) 如果'echo'参数为true,则无返回;如果'echo'为false,则为HTML菜单。



源码

查看源码 官方文档


更新日志

版本描述
4.7.0添加了item_spacing参数。
4.4.0添加了menu_idcontainerbeforeafterwalker参数。
2.7.0开始引入

使用示例

  • 示例1

    将主页显示为页面
    以下示例将“主页”添加到显示页面列表的开头。此外,包装在div元素中的页面(页面ID 5、9和23)将从显示的页面列表中排除,并按页面顺序列出页面。该列表以标题“页面菜单”开头。

    <h2>Page Menu</h2>
    <?php wp_page_menu('show_home=1&exclude=5,9,23&menu_class=page-navi&sort_column=menu_order'); ?>
    
  • 示例2

    将主页显示为名为Blog的页面
    以下示例将“Blog”(而不是“Home”)添加到显示页面列表的开头:

    <?php wp_page_menu( array( 'show_home' => 'Blog', 'sort_column' => 'menu_order' ) ); ?>
    
  • 示例3

    仅显示主页
    以下示例仅显示指向“主页”的链接。请注意,include=9999'引用的页面ID不存在,因此仅显示主页链接。

    <?php wp_page_menu('show_home=1&include=9999'); ?>