hugo.Store

hugo.Store 函數創建一個全局的持久 scratch pad,用於儲存和操作數據。要創建局部範圍的塗鴉板,可以使用 newScratch 函數。

方法

Set

設定指定鍵的值。

{{ hugo.Store.Set "greeting" "Hello" }}
Get

獲取指定鍵的值。

{{ hugo.Store.Set "greeting" "Hello" }}
{{ hugo.Store.Get "greeting" }} → Hello
Add

將指定的值添加到該鍵的現有值上。

單個值時,Add 支持 Go 的 + 運算符。如果第一次為鍵添加的是數組或切片,隨後的添加將附加到該列表中。

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

傳入 keymapKeyvalue,將 mapKeyvalue 添加到指定的 key 中的映射中。

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

傳入 keymapKey,從指定的 key 中刪除 mapKey 對應的映射。

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

返回按 mapKey 排序的指定 key 的值的數組。

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

刪除指定的鍵。

{{ hugo.Store.Set "greeting" "Hello" }}
{{ hugo.Store.Delete "greeting" }}

決定性值

Store 方法常用於在短代碼、通過短代碼調用的部分模板中,或在 Markdown 渲染鉤子中設置塗鴉板的值。在這三種情況下,直到 Hugo 渲染頁面內容之前,塗鴉板的值是不確定的。

如果需要從父模板中訪問塗鴉板的值,而父模板尚未渲染頁面內容,可以通過將返回值賦給 [noop] 變量來觸發內容渲染:

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

你也可以通過 ContentWithoutSummaryFuzzyWordCountLenPlainPlainWordsReadingTimeSummaryTruncatedWordCount 方法觸發內容渲染。例如:

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