方法 菜单项方法

PageRef

语法

MENUENTRY.PageRef

返回值

string

此方法的使用场景很少。

在几乎所有情况下，您都应该使用 URL 方法代替。

解释

如果您在站点配置中定义菜单项时指定了 pageRef 属性，Hugo 会在呈现该条目时查找匹配的页面。

如果找到匹配的页面

如果未找到匹配的页面

  • URL 方法返回条目的 url 属性（如果已设置），否则返回空字符串
  • Page 方法返回 nil
  • Page 对象上的 HasMenuCurrent 和 IsMenuCurrent 方法返回 false

示例

此示例是虚构的。

考虑以下内容结构

content/
├── products.md
└── _index.md

以及以下菜单定义

hugo。
      
menus:
  main:
  - name: Products
    pageRef: /products
    weight: 10
  - name: Services
    pageRef: /services
    weight: 20

[menus]
  [[menus.main]]
    name = 'Products'
    pageRef = '/products'
    weight = 10
  [[menus.main]]
    name = 'Services'
    pageRef = '/services'
    weight = 20

{
   "menus": {
      "main": [
         {
            "name": "Products",
            "pageRef": "/products",
            "weight": 10
         },
         {
            "name": "Services",
            "pageRef": "/services",
            "weight": 20
         }
      ]
   }
}

使用此模板代码

layouts/partials/menu.html
<ul>
  {{ range .Site.Menus.main }}
    <li><a href="{{ .URL }}">{{ .Name }}</a></li>
  {{ end }}
</ul>

Hugo 渲染此 HTML

<ul>
  <li><a href="/products/">Products</a></li>
  <li><a href="">Services</a></li>
</ul>

在上面的示例中请注意，第二个 anchor 元素的 href 属性为空白，因为 Hugo 无法找到“services”页面。

使用此模板代码

layouts/partials/menu.html
<ul>
  {{ range .Site.Menus.main }}
    <li><a href="{{ or .URL .PageRef }}">{{ .Name }}</a></li>
  {{ end }}
</ul>

Hugo 渲染此 HTML

<ul>
  <li><a href="/products/">Products</a></li>
  <li><a href="/services">Services</a></li>
</ul>

在上面的示例中请注意，Hugo 使用站点配置中定义的 pageRef 属性填充第二个 anchor 元素的 href 属性，因为模板代码回退到 PageRef 方法。

另请参阅

上次更新时间：2024 年 11 月 21 日: 记录 PageRef 菜单项方法 (59fa9f214)
改进此页面