Page Objects

The following is a list of page-level variables. Many of these will be defined in the front matter, derived from file location, or extracted from the content itself.

Page Variables

.AlternativeOutputFormats

contains all alternative formats for a given page; this variable is especially useful link rel list in your site’s <head>. (See Output Formats.)

.Content

the content itself, defined below the front matter.

.Data

the data specific to this type of page.

.Date

the date associated with the page; .Date pulls from the date field in a content’s front matter. See also .ExpiryDate, .PublishDate, and .Lastmod.

.Description

the description for the page.

.Dir

the path of the folder containing this content file. The path is relative to the content folder.

.Draft

a boolean, true if the content is marked as a draft in the front matter.

.ExpiryDate

the date on which the content is scheduled to expire; .ExpiryDate pulls from the expirydate field in a content’s front matter. See also .PublishDate, .Date, and .Lastmod.

.File

filesystem-related data for this content file. See also File Variables.

.FuzzyWordCount

the approximate number of words in the content.

.Hugo

see Hugo Variables.

.IsHome

true in the context of the homepage.

.IsNode

always false for regular content pages.

.IsPage

always true for regular content pages.

.IsTranslated

true if there are translations to display.

.Keywords

the meta keywords for the content.

.Kind

the page’s kind. Possible return values are page, home, section, taxonomy, or taxonomyTerm. Note that there are also RSS, sitemap, robotsTXT, and 404 kinds, but these are only available during the rendering of each of these respective page’s kind and therefore not available in any of the Pages collections.

.Lang

language taken from the language extension notation.

.Language

a language object that points to the language’s definition in the site config.

.Lastmod

the date the content was last modified. .Lastmod pulls from the lastmod field in a content’s front matter.

If lastmod is not set, and .GitInfo feature is disabled, the front matter date field will be used.
If lastmod is not set, and .GitInfo feature is enabled, .GitInfo.AuthorDate will be used instead.

See also .ExpiryDate, .Date, .PublishDate, and .GitInfo.

.LinkTitle: access when creating links to the content. If set, Hugo will use the linktitle from the front matter before title.
.Next (deprecated): In older Hugo versions this pointer went the wrong direction. Please use .PrevPage instead.
.NextPage: Pointer to the next regular page (sorted by Hugo’s default sort). Example: {{if .NextPage}}{{.NextPage.Permalink}}{{end}}.
.NextInSection: Pointer to the next regular page within the same section. Pages are sorted by Hugo’s default sort. Example: {{if .NextInSection}}{{.NextInSection.Permalink}}{{end}}.
.OutputFormats: contains all formats, including the current format, for a given page. Can be combined the with .Get function to grab a specific format. (See Output Formats.)
.Pages: a collection of associated pages. This value will be nil within the context of regular content pages. See .Pages.
.Permalink: the Permanent link for this page; see Permalinks
.Plain: the Page content stripped of HTML tags and presented as a string.
.PlainWords: the Page content stripped of HTML as a []string using Go’s strings.Fields to split .Plain into a slice.
.Prev (deprecated): In older Hugo versions this pointer went the wrong direction. Please use .NextPage instead.
.PrevPage: Pointer to the previous regular page (sorted by Hugo’s default sort). Example: {{if .PrevPage}}{{.PrevPage.Permalink}}{{end}}.
.PrevInSection: Pointer to the previous regular page within the same section. Pages are sorted by Hugo’s default sort. Example: {{if .PrevInSection}}{{.PrevInSection.Permalink}}{{end}}.
.PublishDate: the date on which the content was or will be published; .Publishdate pulls from the publishdate field in a content’s front matter. See also .ExpiryDate, .Date, and .Lastmod.
.RSSLink: link to the taxonomies’ RSS link.
.RawContent: raw markdown content without the front matter. Useful with remarkjs.com
.ReadingTime: the estimated time, in minutes, it takes to read the content.
.Ref: returns the permalink for a given reference (e.g., .Ref "sample.md"). .Ref does not handle in-page fragments correctly. See Cross References.
.RelPermalink: the relative permanent link for this page.
.RelRef: returns the relative permalink for a given reference (e.g., RelRef "sample.md"). .RelRef does not handle in-page fragments correctly. See Cross References.
.Site: see Site Variables.
.Sites: returns all sites (languages). A typical use case would be to link back to the main language: <a href="{{ .Sites.First.Home.RelPermalink }}">...</a>.
.Sites.First: returns the site for the first language. If this is not a multilingual setup, it will return itself.
.Summary: a generated summary of the content for easily showing a snippet in a summary view. The breakpoint can be set manually by inserting  at the appropriate place in the content page. See Content Summaries for more details.
.TableOfContents: the rendered table of contents for the page.
.Title: the title for this page.
.Translations: a list of translated versions of the current page. See Multilingual Mode for more information.
.Truncated: a boolean, true if the .Summary is truncated. Useful for showing a “Read more…” link only when necessary. See Summaries for more information.
.Type: the content type of the content (e.g., post).
.URL: the URL for the page relative to the web root. Note that a url set directly in front matter overrides the default relative URL for the rendered page.
.UniqueID: the MD5-checksum of the content file’s path.
.Weight: assigned weight (in the front matter) to this content, used in sorting.
.WordCount: the number of words in the content.

Section Variables and Methods

Also see Sections.

.CurrentSection: The page’s current section. The value can be the page itself if it is a section or the homepage.
.InSection $anotherPage: Whether the given page is in the current section. Note that this will always return false for pages that are not either regular, home or section pages.
.IsAncestor $anotherPage: Whether the current page is an ancestor of the given page. Note that this method is not relevant for taxonomy lists and taxonomy terms pages.
.IsDescendant $anotherPage: Whether the current page is a descendant of the given page. Note that this method is not relevant for taxonomy lists and taxonomy terms pages.
.Parent: A section’s parent section or a page’s section.
.Section: The section this content belongs to. Note: For nested sections, this is the first path element in the directory, for example, /blog/funny/mypost/ => blog.
.Sections: The sections below this content.

The `.Pages` Variable

.Pages is an alias to .Data.Pages. It is conventional to use the aliased form .Pages.

`.Pages` compared to `.Site.Pages`

Variable	Current context	Pages included
`.Site.Pages`	any page	ALL pages of the site: content, sections, taxonomies, etc. – Superset of everything!
`.Site.RegularPages`	any page	Only regular (content) pages – Subset of `.Site.Pages`
`.Pages`	List page	Regular pages under that list page representing the homepage, section, taxonomy term (`/tags`) or taxonomy (`/tags/foo`) page – Subset of `.Site.Pages` or `.Site.RegularPages`, depending on context.
`.Pages`	Single page	empty slice

Note: In the home context (index.html), .Pages is the same as .Site.RegularPages.

Page-level Params

Any other value defined in the front matter in a content file, including taxonomies, will be made available as part of the .Params variable.

---
title: My First Post
date: 2017-02-20T15:26:23-06:00
categories: [objects]
tags: [two,three,four]

With the above front matter, the tags and categories taxonomies are accessible via the following:

.Params.tags
.Params.categories

The .Params variable is particularly useful for the introduction of user-defined front matter fields in content files. For example, a Hugo website on book reviews could have the following front matter in /content/review/book01.md:

---
...
affiliatelink: "http://www.my-book-link.here"
recommendedby: "My Mother"
...
---

These fields would then be accessible to the /themes/yourtheme/layouts/review/single.html template through .Params.affiliatelink and .Params.recommendedby, respectively.

Two common situations where this type of front matter field could be introduced is as a value of a certain attribute like href="" or by itself to be displayed as text to the website’s visitors.

/themes/yourtheme/layouts/review/single.html


<h3><a href={{ printf "%s" $.Params.affiliatelink }}>Buy this book</a></h3>
<p>It was recommended by {{ .Params.recommendedby }}.</p>

This template would render as follows, assuming you’ve set uglyURLs to false in your site config:

yourbaseurl/review/book01/index.html


<h3><a href="http://www.my-book-link.here">Buy this book</a></h3>
<p>It was recommended by my Mother.</p>

The `.Param` Method

In Hugo, you can declare params in individual pages and globally for your entire website. A common use case is to have a general value for the site param and a more specific value for some of the pages (i.e., a header image):

{{ $.Param "header_image" }}

The .Param method provides a way to resolve a single value according to it’s definition in a page parameter (i.e. in the content’s front matter) or a site parameter (i.e., in your config).

Access Nested Fields in Front Matter

When front matter contains nested fields like the following:

---
author:
  given_name: John
  family_name: Feminella
  display_name: John Feminella
---

.Param can access these fields by concatenating the field names together with a dot:

{{ $.Param "author.display_name" }}

If your front matter contains a top-level key that is ambiguous with a nested key, as in the following case:

---
favorites.flavor: vanilla
favorites:
  flavor: chocolate
---

The top-level key will be preferred. Therefore, the following method, when applied to the previous example, will print vanilla and not chocolate:

{{ $.Param "favorites.flavor" }}
=> vanilla

Page Objects

Page Variables

Section Variables and Methods

The `.Pages` Variable

`.Pages` compared to `.Site.Pages`

Page-level Params

The `.Param` Method

Access Nested Fields in Front Matter

.Get

.GetPage

.HasMenuCurrent

.IsMenuCurrent

.Param

.Render

.Scratch

Page Objects

Page Variables

Section Variables and Methods

The .Pages Variable

.Pages compared to .Site.Pages

Page-level Params

The .Param Method

Access Nested Fields in Front Matter

The `.Pages` Variable

`.Pages` compared to `.Site.Pages`

The `.Param` Method