mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
e509cac533
cb18a5183 Fix broken link 07a0198bf Config: Place Google Analytics tag ID under the services key 4bf0c719f Fix typo 50d8ad1af Fix muiltilingual menu definition instructions 1a32519a9 Fix typos 6f34ca8e0 Explain usage of front matter to target a template 5bd977257 Improve goldmark config docs 447632938 Remove Docker notes from installation instructions 84741d173 Update reference to hugo.work 0338d7c71 Fix menu template f5d2f5ed4 Fix typos in content/en/functions/fmt a3a40ff99 Add return type to functions 85ac3e779 Remove outdated feature image d47d889e4 Fix signatures 7551ba28f Document safe.JSStr function e77993be0 Document keyVals function 4dba20db3 Update theme babf91544 Update echoparam 8c8203efa Adjust related functions 4cb1b30fc Fix example ba95eca64 Improve showcase prose 5d3dcf366 Add Overmind Studios showcase 8d634ac70 Change code blocks from indented to fenced cfab978e6 Add missing code fences 407dd5c47 Limit related pages for functions to other functions 9fa67d981 Fix .Site.LastChange doc 393aa16d0 netlify: Hugo 0.119.0 f864af97a docs: Even more about images.Process 9d772d5f0 docs: More about images.Process bc655f869 docs: Regen docshelper 41c3536d1 Merge commit '9aec42c5452b3eb224888c50ba1c3f3b68a447e9' 918ed53f4 Add images.Process filter 573645883 Add $image.Process a1151b0fd Add images.Opacity filter git-subtree-dir: docs git-subtree-split: cb18a5183fc62f301ffde50b8c39f03e4b897aec
111 lines
2.4 KiB
Markdown
111 lines
2.4 KiB
Markdown
---
|
|
title: .Store
|
|
description: Returns a Scratch that is not reset on server rebuilds.
|
|
categories: [functions]
|
|
keywords: []
|
|
menu:
|
|
docs:
|
|
parent: functions
|
|
function:
|
|
aliases: []
|
|
returnType:
|
|
signatures: []
|
|
relatedFunctions:
|
|
- .Store
|
|
- .Scratch
|
|
---
|
|
|
|
The `.Store` method on `.Page` returns a [Scratch] to store and manipulate data. In contrast to the `.Scratch` method, this Scratch is not reset on server rebuilds.
|
|
|
|
[Scratch]: /functions/scratch/
|
|
|
|
### Methods
|
|
|
|
#### .Set
|
|
|
|
Sets the value of a given key.
|
|
|
|
```go-html-template
|
|
{{ .Store.Set "greeting" "Hello" }}
|
|
```
|
|
|
|
#### .Get
|
|
|
|
Gets the value of a given key.
|
|
|
|
```go-html-template
|
|
{{ .Store.Set "greeting" "Hello" }}
|
|
|
|
{{ .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.
|
|
|
|
```go-html-template
|
|
{{ .Store.Add "greetings" "Hello" }}
|
|
{{ .Store.Add "greetings" "Welcome" }}
|
|
|
|
{{ .Store.Get "greetings" }} → HelloWelcome
|
|
```
|
|
|
|
```go-html-template
|
|
{{ .Store.Add "total" 3 }}
|
|
{{ .Store.Add "total" 7 }}
|
|
|
|
{{ .Store.Get "total" }} → 10
|
|
```
|
|
|
|
```go-html-template
|
|
{{ .Store.Add "greetings" (slice "Hello") }}
|
|
{{ .Store.Add "greetings" (slice "Welcome" "Cheers") }}
|
|
|
|
{{ .Store.Get "greetings" }} → []interface {}{"Hello", "Welcome", "Cheers"}
|
|
```
|
|
|
|
#### .SetInMap
|
|
|
|
Takes a `key`, `mapKey` and `value` and adds a map of `mapKey` and `value` to the given `key`.
|
|
|
|
```go-html-template
|
|
{{ .Store.SetInMap "greetings" "english" "Hello" }}
|
|
{{ .Store.SetInMap "greetings" "french" "Bonjour" }}
|
|
|
|
{{ .Store.Get "greetings" }} → map[french:Bonjour english:Hello]
|
|
```
|
|
|
|
#### .DeleteInMap
|
|
|
|
Takes a `key` and `mapKey` and removes the map of `mapKey` from the given `key`.
|
|
|
|
```go-html-template
|
|
{{ .Store.SetInMap "greetings" "english" "Hello" }}
|
|
{{ .Store.SetInMap "greetings" "french" "Bonjour" }}
|
|
{{ .Store.DeleteInMap "greetings" "english" }}
|
|
|
|
{{ .Store.Get "greetings" }} → map[french:Bonjour]
|
|
```
|
|
|
|
#### .GetSortedMapValues
|
|
|
|
Returns an array of values from `key` sorted by `mapKey`.
|
|
|
|
```go-html-template
|
|
{{ .Store.SetInMap "greetings" "english" "Hello" }}
|
|
{{ .Store.SetInMap "greetings" "french" "Bonjour" }}
|
|
|
|
{{ .Store.GetSortedMapValues "greetings" }} → [Hello Bonjour]
|
|
```
|
|
|
|
#### .Delete
|
|
|
|
Removes the given key.
|
|
|
|
```go-html-template
|
|
{{ .Store.Set "greeting" "Hello" }}
|
|
|
|
{{ .Store.Delete "greeting" }}
|
|
```
|