HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门
    • 本节内容
    • 快速开始
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面捆绑
    • 内容格式
    • 前言
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基础模板
    • 主页模板
    • 单页模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 部分模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • cast
    • collections
    • compare
    • crypto
    • css
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hash
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • 方法
    • 本节内容
    • Duration
    • Menu
    • 菜单项
    • Page
    • Pager
    • Pages
    • Resource
    • 短代码
    • Site
    • Taxonomy
    • Time
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • 图片
    • 链接
    • 透传
    • 表格
  • 短代码
    • 本节内容
    • 评论
    • 详情
    • 图表
    • Gist
    • 高亮
    • Instagram
    • Param
    • QR
    • Ref
    • Relref
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 转译为 CSS
    • PostCSS
    • 后处理
    • JavaScript 构建
    • 资源压缩
    • 连接资源
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • CLI
  • 故障排除
    • 本节内容
    • 审计
    • 日志
    • 检查
    • 弃用
    • 性能
    • 常见问题
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Azure 静态 Web 应用上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
方法 页面方法

Scratch

返回给定页面上的一个“暂存区”,用于存储和操作数据。

语法

PAGE.Scratch

返回值

maps.Scratch

在 v0.138.0 中已弃用。

请改用 PAGE.Store 方法。

这是一个软弃用。此方法将在未来的版本中删除,但删除日期尚未确定。虽然如果您继续使用此方法,Hugo 不会发出警告,但您应尽快开始使用 PAGE.Store。

从 v0.138.0 开始,PAGE.Scratch 方法已别名为 PAGE.Store。

Page 对象上的 Scratch 方法创建一个暂存区,用于存储和操作数据。要创建一个在服务器重建时不会重置的暂存区,请改用 Store 方法。

要创建一个不附加到 Page 对象的局部作用域暂存区,请使用 newScratch 函数。

方法

Set

设置给定键的值。

{{ .Scratch.Set "greeting" "Hello" }}
Get

获取给定键的值。

{{ .Scratch.Set "greeting" "Hello" }}
{{ .Scratch.Get "greeting" }} → Hello
Add

将给定值添加到给定键的现有值中。

对于单个值,Add 接受支持 Go 的 + 运算符的值。如果键的第一个 Add 是一个数组或切片,则后续的添加将附加到该列表中。

{{ .Scratch.Set "greeting" "Hello" }}
{{ .Scratch.Add "greeting" "Welcome" }}
{{ .Scratch.Get "greeting" }} → HelloWelcome
{{ .Scratch.Set "total" 3 }}
{{ .Scratch.Add "total" 7 }}
{{ .Scratch.Get "total" }} → 10
{{ .Scratch.Set "greetings" (slice "Hello") }}
{{ .Scratch.Add "greetings" (slice "Welcome" "Cheers") }}
{{ .Scratch.Get "greetings" }} → [Hello Welcome Cheers]
SetInMap

接受一个 key、mapKey 和 value,并将 mapKey 和 value 的映射添加到给定的 key。

{{ .Scratch.SetInMap "greetings" "english" "Hello" }}
{{ .Scratch.SetInMap "greetings" "french" "Bonjour" }}
{{ .Scratch.Get "greetings" }} → map[english:Hello french:Bonjour]
DeleteInMap

接受一个 key 和 mapKey,并从给定的 key 中删除 mapKey 的映射。

{{ .Scratch.SetInMap "greetings" "english" "Hello" }}
{{ .Scratch.SetInMap "greetings" "french" "Bonjour" }}
{{ .Scratch.DeleteInMap "greetings" "english" }}
{{ .Scratch.Get "greetings" }} → map[french:Bonjour]
GetSortedMapValues

返回按 mapKey 排序的 key 中的值数组。

{{ .Scratch.SetInMap "greetings" "english" "Hello" }}
{{ .Scratch.SetInMap "greetings" "french" "Bonjour" }}
{{ .Scratch.GetSortedMapValues "greetings" }} → [Hello Bonjour]
Delete

删除给定键。

{{ .Scratch.Set "greeting" "Hello" }}
{{ .Scratch.Delete "greeting" }}

确定值

Scratch 方法通常用于在短代码、由短代码调用的部分模板或 Markdown 渲染钩子中设置暂存区值。在这三种情况下,在 Hugo 渲染页面内容之前,暂存区值都是不确定的。

如果您需要从父模板访问暂存区值,并且父模板尚未渲染页面内容,您可以通过将返回值分配给一个 noop 变量来触发内容渲染。

{{ $noop := .Content }}
{{ .Store.Get "mykey" }}

您还可以使用 ContentWithoutSummary、FuzzyWordCount、Len、Plain、PlainWords、ReadingTime、Summary、Truncated 和 WordCount 方法触发内容渲染。例如

{{ $noop := .WordCount }}
{{ .Store.Get "mykey" }}

另请参阅

  • PAGE.Store
  • collections.NewScratch

本页内容

  • 方法
  • 确定值

本节内容

  • 别名
  • AllTranslations
  • AlternativeOutputFormats
  • Ancestors
  • BundleType
  • CodeOwners
  • Content
  • 无摘要内容
  • 当前章节
  • 数据
  • 日期
  • 描述
  • 草稿
  • 等式
  • 有效期
  • 文件
  • 第一章节
  • 片段
  • 模糊字数
  • 获取页面
  • 获取术语
  • Git 信息
  • 是否有当前菜单项
  • 是否有短代码
  • 已过滤的标题
  • 是否在章节中
  • 是否为祖先
  • 是否为后代
  • 是否为主页
  • 是否为当前菜单项
  • 是否为节点
  • 是否为页面
  • 是否为章节
  • 是否已翻译
  • 关键词
  • 类型
  • 语言
  • 最后修改时间
  • 布局
  • 长度
  • 链接标题
  • 下一个
  • 同一章节中的下一个
  • 输出格式
  • Page
  • PAGE.Store
  • Pages
  • 分页
  • 分页器
  • Param
  • 参数
  • 父级
  • 路径
  • 永久链接
  • 纯文本
  • 纯文本单词
  • 上一个
  • 同一章节中的上一个
  • 发布日期
  • 原始内容
  • 阅读时间
  • Ref
  • 常规页面
  • 递归常规页面
  • 相对永久链接
  • 相对引用
  • 渲染
  • 渲染短代码
  • 渲染字符串
  • 资源
  • Scratch
  • 章节
  • 章节
  • Site
  • 站点地图
  • 站点
  • 别名
  • 摘要
  • 目录
  • 标题
  • 翻译键
  • 翻译
  • 已截断
  • 类型
  • 权重
  • 字数
最后更新:2024 年 11 月 5 日:文档软弃用 PAGE.Scratch (c3a476a19)
改进此页面
由 Hugo 作者
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

您的公司?
 

Hugo 标志版权所有 © Steve Francia 2013–2025。

Hugo 地鼠基于 Renée French 的原创作品。

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 入门
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • 短代码
  • Hugo 模块
  • Hugo 管道
  • CLI
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护