hugo/docs/content/en/methods/site/Store.md

title	description	categories	keywords	action	toc
Store	Returns a "scratch pad" to store and manipulate data, scoped to the current site.			related returnType signatures methods/page/store functions/hugo/store functions/collections/NewScratch maps.Scratch site.Store	true

{{< new-in 0.139.0 />}}

Use the Store method on a Site object to create a scratch pad to store and manipulate data, scoped to the current site. To create a scratch pad with a different scope, refer to the scope section below.

Methods

Set

Sets the value of a given key.

{{ site.Store.Set "greeting" "Hello" }}

Get

Gets the value of a given key.

{{ site.Store.Set "greeting" "Hello" }}
{{ site.Store.Get "greeting" }} → Hello

Add

Adds a given value to existing value(s) of the given key.

For single values, Add accepts values that support Go's + operator. If the first Add for a key is an array or slice, the following adds will be appended to that list.

{{ site.Store.Set "greeting" "Hello" }}
{{ site.Store.Add "greeting" "Welcome" }}
{{ site.Store.Get "greeting" }} → HelloWelcome

{{ site.Store.Set "total" 3 }}
{{ site.Store.Add "total" 7 }}
{{ site.Store.Get "total" }} → 10

{{ site.Store.Set "greetings" (slice "Hello") }}
{{ site.Store.Add "greetings" (slice "Welcome" "Cheers") }}
{{ site.Store.Get "greetings" }} → [Hello Welcome Cheers]

SetInMap

Takes a key, mapKey and value and adds a map of mapKey and value to the given key.

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

DeleteInMap

Takes a key and mapKey and removes the map of mapKey from the given key.

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

GetSortedMapValues

Returns an array of values from key sorted by mapKey.

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

Delete

Removes the given key.

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

{{% include "_common/scratch-pad-scope.md" %}}

Determinate values

The Store method is often used to set scratch pad values within a shortcode, a partial template called by a shortcode, or by a Markdown render hook. In all three cases, the scratch pad values are indeterminate until Hugo renders the page content.

If you need to access a scratch pad value from a parent template, and the parent template has not yet rendered the page content, you can trigger content rendering by assigning the returned value to a noop variable:

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

You can also trigger content rendering with the ContentWithoutSummary, FuzzyWordCount, Len, Plain, PlainWords, ReadingTime, Summary, Truncated, and WordCount methods. For example:

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