文档章节

模板函数

查询模板系统自身:判断模板是否存在、取当前模板名,以及在局部模板里拿到调用方内容。

难度
进阶
预计用时
按需查阅

开始之前,你需要

  • 你已经写过至少一个局部模板或短代码模板,知道模板是通过名字被调用的。

读完之后你能

  • 用 templates.Exists 在调用前判断模板是否存在,避免构建期直接报错;
  • 用 templates.Current 查出当前正在执行的是哪个模板(排查「到底走的哪个模板」);
  • 用 templates.Inner 在局部模板里拿到调用方传入的 .Inner;
  • 用 templates.Defer 把耗时的模板求值推迟到构建结束(含在 range 内取用 .Page 时的限制)。

接着读:模板查找顺序 · 简介 · Include

这一组包含什么

函数 用途
Current 当前执行的模板名,排查「究竟走了哪个模板」
Defer 把求值推迟到构建结束,用于必须延后才知道结果的场合
Exists 判断某个模板是否存在,用于「有则用、没有则回退」
Inner 在局部模板里取调用方传入的内容

什么时候用

  • 「改了模板但页面没变」→ 先用 templates.Current 确认实际生效的是哪个文件。Hugo 的模板查找有优先级(项目 → 主题),改错层不会报错,只会静默不生效,查找顺序见模板查找顺序;
  • 「主题可能提供、也可能不提供某个局部模板」→ 用 templates.Exists 做回退,而不是让构建失败;
  • 需要缓存局部模板的渲染结果 → 那是 partials.IncludeCached,不在本组。

下方列出本站收录的本组全部函数。

本章内容

  • templates.Current 返回当前正在执行的模板的相关信息。 (今天)
  • templates.Defer 把模板的执行推迟到所有站点与输出格式都渲染完成之后。 (今天)
  • templates.Exists 报告相对于 `layouts` 目录的给定路径下是否存在模板文件。 (今天)
  • templates.Inner 执行由局部模板(partial)调用所包裹的内容块。 (今天)