hugo/content/en/methods/page/ExpiryDate.md
Bjørn Erik Pedersen 9b0050e9aa Squashed 'docs/' content from commit 5c085a37b
git-subtree-dir: docs
git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d
2024-01-27 10:48:33 +01:00

1.3 KiB

title description categories keywords action
ExpiryDate Returns the expiry date of the given page.
related returnType signatures
methods/page/Date
methods/page/LastMod
methods/page/PublishDate
time.Time
PAGE.ExpiryDate

By default, Hugo excludes expired pages when building your site. To include expired pages, use the --buildExpired command line flag.

Set the expiry date in front matter:

{{< code-toggle file=content/news/article-1.md fm=true >}} title = 'Article 1' expiryDate = 2024-10-19T00:32:13-07:00 {{< /code-toggle >}}

The expiry date is a time.Time value. Format and localize the value with the time.Format function, or use it with any of the time methods.

{{ .ExpiryDate | time.Format ":date_medium" }} → Oct 19, 2024

In the example above we explicitly set the expiry date in front matter. With Hugo's default configuration, the ExpiryDate method returns the front matter value. This behavior is configurable, allowing you to set fallback values if the expiry date is not defined in front matter. See details.