Scratch
语法
PAGE.Scratch
返回值
maps.Scratch
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" }}