Methods

A quick reference guide to Hugo’s methods, grouped by object.

Duration

Use these methods with a time.Duration value.

Abs: Returns the absolute value of the given time.Duration value.
Hours: Returns the time.Duration value as a floating point number of hours.
Microseconds: Returns the time.Duration value as an integer microsecond count.
Milliseconds: Returns the time.Duration value as an integer millisecond count.
Minutes: Returns the time.Duration value as a floating point number of minutes.
Nanoseconds: Returns the time.Duration value as an integer nanosecond count.
Round: Returns the result of rounding DURATION1 to the nearest multiple of DURATION2.
Seconds: Returns the time.Duration value as a floating point number of seconds.
Truncate: Returns the result of rounding DURATION1 toward zero to a multiple of DURATION2.

Use these methods when ranging through menu entries.

ByName: Returns the given menu with its entries sorted by name.
ByWeight: Returns the given menu with its entries sorted by weight, then by name, then by identifier.
Limit: Returns the given menu, limited to the first N entries.
Reverse: Returns the given menu, reversing the sort order of its entries.

Use these methods in your menu templates.

Children: Returns a collection of child menu entries, if any, under the given menu entry.
HasChildren: Reports whether the given menu entry has child menu entries.
Identifier: Returns the identifier property of the given menu entry.
KeyName: Returns the identifier property of the given menu entry, falling back to its name property.
Menu: Returns the identifier of the menu that contains the given menu entry.
Name: Returns the name property of the given menu entry.
Page: Returns the Page object associated with the given menu entry.
PageRef: Returns the pageRef property of the given menu entry.
Params: Returns the params property of the given menu entry.
Parent: Returns the parent property of the given menu entry.
Post: Returns the post property of the given menu entry.
Pre: Returns the pre property of the given menu entry.
Title: Returns the title property of the given menu entry.
URL: Returns the relative permalink of the page associated with the given menu entry, else its url property.
Weight: Returns the weight property of the given menu entry.

Output format

Use these methods with an OutputFormat object.

MediaType: Returns the media type of the given output format.
Name: Returns the identifier of the given output format.
Permalink: Returns the permalink of the page generated by the current output format.
Rel: Returns the rel value of the given output format, either the default or as defined in your project configuration.
RelPermalink: Returns the relative permalink of the page generated by the current output format.

Resource

Use these methods with a global, page, or remote Resource object.

Colors: Applicable to images, returns a slice of the most dominant colors using a simple histogram method.
Content: Returns the content of the given resource.
Crop: Applicable to images, returns a new image resource cropped according to the given processing specification.
Data: Applicable to resources returned by the resources.GetRemote function, returns information from the HTTP response.
Err: Applicable to resources returned by the resources.GetRemote function, returns an error message if the HTTP request fails, else nil.
Exif: Returns an object containing Exif metadata for supported image formats.
Fill: Applicable to images, returns a new image resource cropped and resized according to the given processing specification.
Filter: Applicable to images, applies one or more image filters to the given image resource.
Fit: Applicable to images, returns a new image resource downscaled to fit according to the given processing specification.
Height: Applicable to images, returns the height of the given resource.
MediaType: Returns a media type object for the given resource.
Meta: Applicable to images, returns an object containing Exif, IPTC, and XMP metadata for supported image formats.
Name: Returns the name of the given resource as optionally defined in front matter, falling back to its file path.
Params: Returns a map of resource parameters as defined in front matter.
Permalink: Publishes the given resource and returns its permalink.
Process: Applicable to images, returns a new image resource processed according to the given processing specification.
Publish: Publishes the given resource.
RelPermalink: Publishes the given resource and returns its relative permalink.
Resize: Applicable to images, returns a new image resource resized according to the given processing specification.
ResourceType: Returns the main type of the given resource's media type.
Title: Returns the title of the given resource as optionally defined in front matter, falling back to a relative path or hashed file name depending on resource type.
Width: Applicable to images, returns the width of the given resource.

Shortcode

Use these methods in your shortcode templates.

Get: Returns the value of the given argument.
Inner: Returns the content between opening and closing shortcode tags, applicable when the shortcode call includes a closing tag.
InnerDeindent: Returns the content between opening and closing shortcode tags, with indentation removed, applicable when the shortcode call includes a closing tag.
IsNamedParams: Reports whether the shortcode call uses named arguments.
Name: Returns the shortcode file name, excluding the file extension.
Ordinal: Returns the zero-based ordinal of the shortcode in relation to its parent.
Page: Returns the Page object from which the shortcode was called.
Params: Returns a collection of the shortcode arguments.
Parent: Returns the parent shortcode context in nested shortcodes.
Position: Returns the file name and position from which the shortcode was called.
Ref: Returns the absolute URL of the page with the given path, language, and output format.
RelRef: Returns the relative URL of the page with the given path, language, and output format.
Scratch: Returns a persistent data structure for storing and manipulating keyed values, scoped to the current shortcode.
Site: Returns the Site object.
Store: Returns a persistent data structure for storing and manipulating keyed values, scoped to the current shortcode.

Site

Use these methods with a Site object.

AllPages: Returns a collection of all pages in all languages.
BaseURL: Returns the base URL as defined in your project configuration.
BuildDrafts: Reports reports whether draft publishing is enabled for the current build.
Config: Returns a subset of your project configuration.
Copyright: Returns the copyright notice as defined in your project configuration.
Data: Returns a data structure composed from the files in the data directory.
Dimension: Returns the dimension object for the given dimension for the given site.
GetPage: Returns a Page object from the given path.
Home: Returns the home Page object for the given site.
IsDefault: Reports whether the given site is the default site across all dimensions.
Language: Returns the Language object for the given site.
LanguagePrefix: Returns the URL language prefix, if any, for the given site.
Languages: Returns a collection of language objects for all sites, ordered by language weight.
Lastmod: Returns the last modification date of site content.
MainSections: Returns a slice of the main section names as defined in your project configuration, falling back to the top-level section with the most pages.
Menus: Returns a collection of menu objects for the given site.
Pages: Returns a collection of all pages.
Param: Returns the site parameter with the given key.
Params: Returns a map of custom parameters as defined in your project configuration.
RegularPages: Returns a collection of all regular pages.
Role: Returns the Role object for the given site.
Sections: Returns a collection of top-level section pages.
Sites: Returns a collection of all sites for all dimensions.
Store: Returns a persistent data structure for storing and manipulating keyed values, scoped to the current 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.
Title: Returns the title as defined in your project configuration.
Version: Returns the Version object for the given site.

Taxonomy

Use these methods with a Taxonomy object.

Alphabetical: Returns an ordered taxonomy, sorted alphabetically by term.
ByCount: Returns an ordered taxonomy, sorted by the number of pages associated with each term.
Count: Returns the number of number of weighted pages to which the given term has been assigned.
Get: Returns a slice of weighted pages to which the given term has been assigned.
Page: Returns the taxonomy page or nil if the taxonomy has no terms.

Time

Use these methods with a time.Time value.

Add: Returns the given time plus the given duration.
AddDate: Returns the time corresponding to adding the given number of years, months, and days to the given time.Time value.
After: Reports whether TIME1 is after TIME2.
Before: Reports whether TIME1 is before TIME2.
Day: Returns the day of the month of the given time.Time value.
Equal: Reports whether TIME1 is equal to TIME2.
Format: Returns a textual representation of the time.Time value formatted according to the layout string.
Hour: Returns the hour within the day of the given time.Time value, in the range [0, 23].
IsDST: Reports whether the given time.Time value is in Daylight Savings Time.
IsZero: Reports whether the given time.Time value represents the zero time instant, January 1, year 1, 00:00:00 UTC.
Local: Returns the given time.Time value with the location set to local time.
Minute: Returns the minute offset within the hour of the given time.Time value, in the range [0, 59].
Month: Returns the month of the year of the given time.Time value.
Nanosecond: Returns the nanosecond offset within the second of the given time.Time value, in the range [0, 999999999].
Round: Returns the result of rounding TIME to the nearest multiple of DURATION since January 1, 0001, 00:00:00 UTC.
Second: Returns the second offset within the minute of the given time.Time value, in the range [0, 59].
Sub: Returns the duration computed by subtracting TIME2 from TIME1.
Truncate: Returns the result of rounding TIME down to a multiple of DURATION since January 1, 0001, 00:00:00 UTC.
Unix: Returns the given time.Time value expressed as the number of seconds elapsed since January 1, 1970 UTC.
UnixMicro: Returns the given time.Time value expressed as the number of microseconds elapsed since January 1, 1970 UTC.
UnixMilli: Returns the given time.Time value expressed as the number of milliseconds elapsed since January 1, 1970 UTC.
UnixNano: Returns the given time.Time value expressed as the number of nanoseconds elapsed since January 1, 1970 UTC.
UTC: Returns the given time.Time value with the location set to UTC.
Weekday: Returns the day of the week of the given time.Time value.
Year: Returns the year of the given time.Time value.
YearDay: Returns the day of the year of the given time.Time value, in the range [1, 365] for non-leap years, and [1, 366] in leap years.

Last updated: April 10, 2025 : Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)

Improve this page

QR code linking to https://gohugo.io/quick-reference/methods/

Methods

Duration

Menu

Menu entry

Output format

Page

Pages

Resource

Shortcode

Site

Taxonomy

Time

Duration

Menu

Menu entry

Output format

Page

Pager

Pages

Resource

Shortcode

Site

Taxonomy

Time