CODEWITHSUNDEEP
gogo-templates
WoJ
WoJ

Reputation: 30074

How to declare a global variable in a template?

I need to write a template where I first define some variables, and then use them in what will be generated from the template:

{{ if $value.Env.CADDY_URL }}
    {{ $url := $value.Env.CADDY_URL }}
{{ else }}
    {{ $url := printf "http://%s.example.info" $value.Name }}
{{ end }}

{{/* more template */}}
{{/* and here I would like to use $url defined above */}}
{{ $url }}

I get the error 

undefined variable "$url"

Reading the documentation, I see that

A variable's scope extends to the "end" action of the control structure ("if", "with", or "range") in which it is declared, or to the end of the template if there is no such control structure.

Does this mean that there are no global (or scoped on the whole template) variables? Or is there a way to define $url so that it can be reused later in the template?

Upvotes: 0

Views: 724

Answers (1)

icza
icza

Reputation: 418625

Variables are scoped. You create the $url variable inside the {{if}} and {{else}} blocks, so they are not visible outside of those blocks.

Create the variable before the {{if}}, and use assignment = instead of declaration :=:

{{$url := ""}}
{{ if . }}
    {{ $url = "http://true.com" }}
{{ else }}
    {{ $url = "http://false.com" }}
{{ end }}

{{ $url }}

Testing it:

t := template.Must(template.New("").Parse(src))

fmt.Println(t.Execute(os.Stdout, true))
fmt.Println(t.Execute(os.Stdout, false))

Output (try it on the Go Playground):

http://true.com<nil>
http://false.com<nil>

Note: Modifying template variables with assignment was added in Go 1.11, so you need to build your app with Go 1.11 or newer. If you're using an older version, you cannot modify values of template variables.

Edit: I've found a duplicate: How do I assign variables within a conditional

You can mimic "changeable template variables" in earlier versions, see this question for examples: In a Go template range loop, are variables declared outside the loop reset on each iteration?

Upvotes: 1

Related Questions