HUGO

  • News
  • Docs
  • Themes
  • Showcase
  • Community
  • GitHub
gohugoio Star
  • About Hugo
    • Overview
    • What is Hugo
    • Hugo features
    • Static site generators
    • Hugo's security model
    • Hugo and the GDPR
    • License
  • Installation
    • Overview
    • macOS
    • Linux
    • Windows
    • BSD
  • Getting started
    • Overview
    • Quick start
    • Basic usage
    • Directory structure
    • Configuration
    • Configure markup
    • Glossary of terms
    • External learning resources
  • Content management
    • Overview
    • Organization
    • Page bundles
    • Content formats
    • Diagrams
    • Front matter
    • Build options
    • Page resources
    • Image processing
    • Shortcodes
    • Related content
    • Sections
    • Content types
    • Archetypes
    • Taxonomies
    • Summaries
    • Links and cross references
    • URL management
    • Menus
    • Static files
    • Table of contents
    • Comments
    • Multilingual
    • Syntax highlighting
  • Templates
    • Overview
    • Templating
    • Template lookup order
    • Base templates and blocks
    • Single page templates
    • List templates
    • Homepage template
    • Section templates
    • Taxonomy templates
    • Pagination
    • Content view templates
    • Partial templates
    • Shortcode templates
    • Menu templates
    • Data templates
    • RSS templates
    • Sitemap templates
    • Local file templates
    • Internal templates
    • Render hooks
    • Custom output formats
    • 404 page
    • Robots.txt
  • Functions
    • Overview
    • cast
    • collections
    • compare
    • crypto
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • Methods
    • Overview
    • Duration
    • Menu
    • Menu entry
    • Page
    • Pages
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
  • Quick reference
    • Overview
    • Emojis
    • Functions
    • Methods
    • Page collections
  • Variables
    • Overview
    • File variables
    • Git variables
    • Menu entry variables
    • Page variables
    • Pages variables
    • Shortcode variables
    • Site variables
    • Taxonomy variables
  • Hugo Modules
    • Overview
    • Configure Hugo modules
    • Use Hugo Modules
    • Theme components
  • Hugo Pipes
    • Overview
    • Introduction
    • Transpile Sass to CSS
    • PostCSS
    • PostProcess
    • JavaScript building
    • Babel
    • Asset minification
    • Concatenating assets
    • Fingerprinting and SRI hashing
    • Resource from string
    • Resource from template
  • CLI
  • Troubleshooting
    • Overview
    • Audit
    • Logging
    • Inspection
    • Deprecation
    • Performance
    • FAQs
  • Developer tools
    • Overview
    • Editor plugins
    • Front-ends
    • Search
    • Migrations
    • Other projects
  • Hosting and deployment
    • Overview
    • Hugo Deploy
    • Deploy with Rclone
    • Deploy with Rsync
    • Host on 21YunBox
    • Host on AWS Amplify
    • Host on Azure Static Web Apps
    • Host on Cloudflare Pages
    • Host on Firebase
    • Host on GitHub Pages
    • Host on GitLab Pages
    • Host on KeyCDN
    • Host on Netlify
    • Host on Render
  • Contribute
    • Overview
    • Development
    • Documentation
    • Themes
  • Maintenance
VARIABLES

Site variables

Use these methods with Site objects. A multilingual project will have two or more sites, one for each language.

We are making an effort to unify our terminology, and to use these terms consistently throughout the documentation.

Historically, we have inconsistently referred to the items on this page as functions, parameters, variables, or methods. They are not functions, parameters, or variables; they are methods.

This page will remain in place as readers become familiar with the unified terminology. See the methods section for a list of methods by object, or the methods quick reference guide.

All methods

Use any of these methods in your templates.

.Site.AllPages
Returns a collection of all pages in all languages.
.Site.BaseURL
Returns the base URL as defined in the site configuration.
.Site.BuildDrafts
Reports whether the current build includes draft pages.
.Site.Config
Returns a subset of the site configuration.
.Site.Copyright
Returns the copyright notice as defined in the site configuration.
.Site.Data
Returns a data structure composed from the files in the data directory.
.Site.DisqusShortname
Returns the Disqus shortname as defined in the site configuration.
.Site.GetPage
Returns a Page object from the given path.
.Site.GoogleAnalytics
Returns the Google Analytics tracking ID as defined in the site configuration.
.Site.Home
Returns the home Page object for the given site.
.Site.IsDevelopment
Reports whether the current running environment is “development”.
.Site.IsMultiLingual
Reports whether the site is multilingual.
.Site.IsServer
Reports whether the built-in development server is running.
.Site.Language
Returns the language object for the given site.
.Site.LanguagePrefix
Returns the URL language prefix, if any, for the given site.
.Site.Languages
Returns a collection of language objects for all sites, ordered by language weight.
.Site.LastChange
Returns the last modification date of site content.
.Site.MainSections
Returns a slice of the main section names as defined in the site configuration, falling back to the top level section with the most pages.
.Site.Menus
Returns a collection of menu objects for the given site.
.Site.Pages
Returns a collection of all pages.
.Site.Param
Returns the site parameter with the given key.
.Site.Params
Returns a map of custom parameters as defined in the site configuration.
.Site.RegularPages
Returns a collection of all regular pages.
.Site.Sections
Returns a collection of first level section pages.
.Site.Sites
Returns a collection of all Site objects, one for each language, ordered by language weight.
.Site.Taxonomies
Returns a data structure containing the site’s taxonomy objects, the terms within each taxonomy object, and the pages to which the terms are assigned.
.Site.Title
Returns the title as defined in the site configuration.

Multilingual

Use these methods with your multilingual projects.

.Site.IsMultiLingual
Reports whether the site is multilingual.
.Site.Language
Returns the language object for the given site.
.Site.LanguagePrefix
Returns the URL language prefix, if any, for the given site.
.Site.Languages
Returns a collection of language objects for all sites, ordered by language weight.

Page collections

Range through these collections when rendering lists on any page.

.Site.Pages
Returns a collection of all pages.
.Site.RegularPages
Returns a collection of all regular pages.
.Site.Sections
Returns a collection of first level section pages.

Global site function

Within a partial template, if you did not pass a Page or Site object in context, you cannot use this syntax:

{{ .Site.SomeMethod }}

Instead, use the global site function:

{{ site.SomeMethod }}

You can use the global site function in all templates to avoid context problems. Its usage is not limited to partial templates.

See also

  • Page variables
  • Pages variables

On this page

  • All methods
  • Multilingual
  • Page collections
  • Global site function
Last updated: November 4, 2023: Miscellaneous updates (80b2241f)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo Sponsors

 

The Hugo logos are copyright © Steve Francia 2013–2024.

The Hugo Gopher is based on an original work by Renée French.

  • News
  • Docs
  • Themes
  • Showcase
  • Community
  • GitHub
  • About Hugo
  • Installation
  • Getting started
  • Content management
  • Templates
  • Functions
  • Methods
  • Quick reference
  • Variables
  • Hugo Modules
  • Hugo Pipes
  • CLI
  • Troubleshooting
  • Developer tools
  • Hosting and deployment
  • Contribute
  • Maintenance