Go template functions, operators, and statements on Hugohttps://v0-122-0--gohugoio.netlify.app/functions/go-template/Recent content in Go template functions, operators, and statements on HugoHugo -- gohugo.ioenandhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/and/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/and/In Go templates, the falsy values are false, 0, any nil pointer or interface value, and any array, slice, map, or string of length zero. Everything else is truthy. {{ and 1 0 "" }} → 0 (int) {{ and 1 false 0 }} → false (bool) {{ and 1 2 3 }} → 3 (int) {{ and "a" "b" "c" }} → c (string) {{ and "a" 1 true }} → true (bool) See Go’s text/template documentation for more information.blockhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/block/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/block/A block is shorthand for defining a template: {{ define "name" }} T1 {{ end }} and then executing it in place: {{ template "name" pipeline }} The typical use is to define a set of root templates that are then customized by redefining the block templates within. layouts/_default/baseof.html <body> <main> {{ block "main" . }} {{ print "default value if 'main' template is empty" }} {{ end }} </main> </body> layouts/_default/single.breakhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/break/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/break/This template code: {{ $s := slice "foo" "bar" "baz" }} {{ range $s }} {{ if eq . "bar" }} {{ break }} {{ end }} <p>{{ . }}</p> {{ end }} Is rendered to: <p>foo</p> See Go’s text/template documentation for more information.continuehttps://v0-122-0--gohugoio.netlify.app/functions/go-template/continue/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/continue/This template code: {{ $s := slice "foo" "bar" "baz" }} {{ range $s }} {{ if eq . "bar" }} {{ continue }} {{ end }} <p>{{ . }}</p> {{ end }} Is rendered to: <p>foo</p> <p>baz</p> See Go’s text/template documentation for more information.definehttps://v0-122-0--gohugoio.netlify.app/functions/go-template/define/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/define/Use with the block statement: {{ block "main" . }} {{ print "default value if 'main' template is empty" }} {{ end }} {{ define "main" }} <h1>{{ .Title }}</h1> {{ .Content }} {{ end }} Use with the partial function: {{ partial "inline/foo.html" (dict "answer" 42) }} {{ define "partials/inline/foo.html" }} {{ printf "The answer is %v." .answer }} {{ end }} Use with the template function: {{ template "foo" (dict "answer" 42) }} {{ define "foo" }} {{ printf "The answer is %v.elsehttps://v0-122-0--gohugoio.netlify.app/functions/go-template/else/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/else/Use with the if statement: {{ $var := "foo" }} {{ if $var }} {{ $var }} → foo {{ else }} {{ print "var is falsy" }} {{ end }} Use with the with statement: {{ $var := "foo" }} {{ with $var }} {{ . }} → foo {{ else }} {{ print "var is falsy" }} {{ end }} Use with the range statement: {{ $var := slice 1 2 3 }} {{ range $var }} {{ .endhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/end/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/end/Use with the if statement: {{ $var := "foo" }} {{ if $var }} {{ $var }} → foo {{ end }} Use with the with statement: {{ $var := "foo" }} {{ with $var }} {{ . }} → foo {{ end }} Use with the range statement: {{ $var := slice 1 2 3 }} {{ range $var }} {{ . }} → 1 2 3 {{ end }} Use with the block statement:ifhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/if/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/if/In Go templates, the falsy values are false, 0, any nil pointer or interface value, and any array, slice, map, or string of length zero. Everything else is truthy. {{ $var := "foo" }} {{ if $var }} {{ $var }} → foo {{ end }} Use with the else statement: {{ $var := "foo" }} {{ if $var }} {{ $var }} → foo {{ else }} {{ print "var is falsy" }} {{ end }} Use else if to check multiple conditions.lenhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/len/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/len/With a string: {{ "ab" | len }} → 2 {{ "" | len }} → 0 With a slice: {{ slice "a" "b" | len }} → 2 {{ slice | len }} → 0 With a map: {{ dict "a" 1 "b" 2 | len }} → 2 {{ dict | len }} → 0 With a collection: {{ site.RegularPages | len }} → 42 You may also determine the number of pages in a collection with:nothttps://v0-122-0--gohugoio.netlify.app/functions/go-template/not/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/not/Unlike the and and or operators, the not operator always returns a boolean value. {{ not true }} → false {{ not false }} → true {{ not 1 }} → false {{ not 0 }} → true {{ not "x" }} → false {{ not "" }} → true Use the not operator, twice in succession, to cast any value to a boolean value. For example: {{ 42 | not | not }} → true {{ "" | not | not }} → false See Go’s text/template documentation for more information.orhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/or/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/or/In Go templates, the falsy values are false, 0, any nil pointer or interface value, and any array, slice, map, or string of length zero. Everything else is truthy. {{ or 0 1 2 }} → 1 {{ or false "a" 1 }} → a {{ or 0 true "a" }} → true {{ or false "" 0 }} → 0 {{ or 0 "" false }} → false See Go’s text/template documentation for more information.rangehttps://v0-122-0--gohugoio.netlify.app/functions/go-template/range/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/range/In Go templates, the falsy values are false, 0, any nil pointer or interface value, and any array, slice, map, or string of length zero. Everything else is truthy. {{ $s := slice "foo" "bar" "baz" }} {{ range $s }} {{ . }} → foo bar baz {{ end }} Use with the else statement: {{ $s := slice "foo" "bar" "baz" }} {{ range $s }} <p>{{ . }}</p> {{ else }} <p>The collection is empty</p> {{ end }} Within a range block:returnhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/return/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/return/The return statement is a custom addition to Go’s text/template package. Used within partial templates, the return statement terminates template execution and returns the given value, if any. The returned value may be of any data type including, but not limited to, bool, float, int, map, resource, slice, and string. A return statement without a value returns an empty string of type template.HTML. Unlike return statements in other languages, Hugo executes the first occurrence of the return statement regardless of its position within logical blocks.templatehttps://v0-122-0--gohugoio.netlify.app/functions/go-template/template/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/template/Use the template function to execute internal templates. For example: {{ range (.Paginate .Pages).Pages }} <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2> {{ end }} {{ template "_internal/pagination.html" . }} You can also use the template function to execute a defined template: {{ template "foo" (dict "answer" 42) }} {{ define "foo" }} {{ printf "The answer is %v." .answer }} {{ end }} The example above can be rewritten using an inline partial template:urlqueryhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/urlquery/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/urlquery/This template code: {{ $u := urlquery "https://" "example.com" | safeURL }} <a href="https://example.org?url={{ $u }}">Link</a> Is rendered to: <a href="https://example.org?url=https%3A%2F%2Fexample.com">Link</a> See Go’s text/template documentation for more information.withhttps://v0-122-0--gohugoio.netlify.app/functions/go-template/with/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/go-template/with/In Go templates, the falsy values are false, 0, any nil pointer or interface value, and any array, slice, map, or string of length zero. Everything else is truthy. {{ $var := "foo" }} {{ with $var }} {{ . }} → foo {{ end }} Use with the else statement: {{ $var := "foo" }} {{ with $var }} {{ . }} → foo {{ else }} {{ print "var is falsy" }} {{ end }} Initialize a variable, scoped to the current block: