hugo/content/en/functions/Format.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.2 KiB

title description categories keywords menu function relatedFunctions toc
.Format Returns a formatted time.Time value.
functions
docs
parent
functions
aliases returnType signatures
string
.Format LAYOUT
true
{{ $t := "2023-01-27T23:44:58-08:00" }}
{{ $t = time.AsTime $t }}
{{ $format := "2 Jan 2006" }}

{{ $t.Format $format }} → 27 Jan 2023

{{% note %}} To return a formatted and localized time.Time value, use the time.Format function instead.

{{% /note %}}

Use the .Format method with any time.Time value, including the four predefined front matter dates:

{{ $format := "2 Jan 2006" }}

{{ .Date.Format $format }}
{{ .PublishDate.Format $format }}
{{ .ExpiryDate.Format $format }}
{{ .Lastmod.Format $format }}

Layout string

{{% readfile file="/functions/_common/time-layout-string.md" %}}

Examples

Given this front matter:

{{< code-toggle fm=true copy=false >}} title = "About time" date = 2023-01-27T23:44:58-08:00 {{< /code-toggle >}}

The examples below were rendered in the America/Los_Angeles time zone:

Format string Result
Monday, January 2, 2006 Friday, January 27, 2023
Mon Jan 2 2006 Fri Jan 27 2023
January 2006 January 2023
2006-01-02 2023-01-27
Monday Friday
02 Jan 06 15:04 MST 27 Jan 23 23:44 PST
Mon, 02 Jan 2006 15:04:05 MST Fri, 27 Jan 2023 23:44:58 PST
Mon, 02 Jan 2006 15:04:05 -0700 Fri, 27 Jan 2023 23:44:58 -0800

UTC and local time

Convert and format any time.Time value to either Coordinated Universal Time (UTC) or local time.

{{ $t := "2023-01-27T23:44:58-08:00" }}
{{ $t = time.AsTime $t }}
{{ $format := "2 Jan 2006 3:04:05 PM MST" }}

{{ $t.UTC.Format $format }} → 28 Jan 2023 7:44:58 AM UTC
{{ $t.Local.Format $format }} → 27 Jan 2023 11:44:58 PM PST

Ordinal representation

Use the humanize function to render the day of the month as an ordinal number:

{{ $t := "2023-01-27T23:44:58-08:00" }}
{{ $t = time.AsTime $t }}

{{ humanize $t.Day }} of {{ $t.Format "January 2006" }} → 27th of January 2023