hugo/content/en/functions/GetPage.md
Bjørn Erik Pedersen e509cac533 Squashed 'docs/' changes from 7ef2dbce4..cb18a5183
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
2023-10-20 09:42:39 +02:00

2.9 KiB

title description categories keywords menu function relatedFunctions
.GetPage Gets a `Page` of a given `path`.
functions
docs
parent
functions
aliases returnType signatures
.GetPage PATH

.GetPage returns a page of a given path. Both Site and Page implements this method. The Page variant will, if given a relative path -- i.e. a path without a leading / -- try look for the page relative to the current page.

{{% note %}} Note: We overhauled and simplified the .GetPage API in Hugo 0.45. Before that you needed to provide a Kind attribute in addition to the path, e.g. {{ .Site.GetPage "section" "blog" }}. This will still work, but is now superfluous. {{% /note %}}

{{ with .Site.GetPage "/blog" }}{{ .Title }}{{ end }}

This method will return nil when no page could be found, so the above will not print anything if the blog section is not found.

To find a regular page in the blog section::

{{ with .Site.GetPage "/blog/my-post.md" }}{{ .Title }}{{ end }}

And since Page also provides a .GetPage method, the above is the same as:

{{ with .Site.GetPage "/blog" }}
{{ with .GetPage "my-post.md" }}{{ .Title }}{{ end }}
{{ end }}

.GetPage and multilingual sites

The previous examples have used the full content file name to look up the post. Depending on how you have organized your content (whether you have the language code in the file name or not, e.g. my-post.en.md), you may want to do the lookup without extension. This will get you the current language's version of the page:

{{ with .Site.GetPage "/blog/my-post" }}{{ .Title }}{{ end }}

.GetPage example

This code snippet---in the form of a partial template---allows you to do the following:

  1. Grab the index object of your tags taxonomy.
  2. Assign this object to a variable, $t
  3. Sort the terms associated with the taxonomy by popularity.
  4. Grab the top two most popular terms in the taxonomy (i.e., the two most popular tags assigned to content.

{{< code file="grab-top-two-tags.html" >}}

    {{ $t := .Site.GetPage "/tags" }} {{ range first 2 $t.Data.Terms.ByCount }}
  • {{ . }}
  • {{ end }}
{{< /code >}}

.GetPage on page bundles

If the page retrieved by .GetPage is a Leaf Bundle, and you need to get the nested page resources in that, you will need to use the methods in .Resources as explained in the Page Resources section.

See the Headless Bundle documentation for an example.