mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
99 lines
2.5 KiB
Markdown
99 lines
2.5 KiB
Markdown
|
---
|
||
|
|
title: Format
|
||
|
|
description: Returns a textual representation of the time.Time value formatted according to the layout string.
|
||
|
|
categories: []
|
||
|
|
keywords: []
|
||
|
|
action:
|
||
|
|
aliases: []
|
||
|
|
related:
|
||
|
|
- functions/time/AsTime
|
||
|
|
- methods/time/UTC
|
||
|
|
- methods/time/Local
|
||
|
|
returnType: string
|
||
|
|
signatures: [TIME.Format LAYOUT]
|
||
|
|
toc: true
|
||
|
|
aliases: [/methods/time/format]
|
||
|
|
---
|
||
|
|
|
||
|
|
```go-template
|
||
|
|
{{ $t := "2023-01-27T23:44:58-08:00" }}
|
||
|
|
{{ $t = time.AsTime $t }}
|
||
|
|
{{ $format := "2 Jan 2006" }}
|
||
|
|
|
||
|
|
{{ $t.Format $format }} → 27 Jan 2023
|
||
|
|
```
|
||
|
|
|
||
|
|
{{% note %}}
|
||
|
|
To [localize] the return value, use the [`time.Format`] function instead.
|
||
|
|
|
||
|
|
[localize]: /getting-started/glossary/#localization
|
||
|
|
[`time.Format`]: /functions/time/format
|
||
|
|
{{% /note %}}
|
||
|
|
|
||
|
|
Use the `Format` method with any `time.Time` value, including the four predefined front matter dates:
|
||
|
|
|
||
|
|
```go-html-template
|
||
|
|
{{ $format := "2 Jan 2006" }}
|
||
|
|
|
||
|
|
{{ .Date.Format $format }}
|
||
|
|
{{ .PublishDate.Format $format }}
|
||
|
|
{{ .ExpiryDate.Format $format }}
|
||
|
|
{{ .Lastmod.Format $format }}
|
||
|
|
```
|
||
|
|
|
||
|
|
{{% note %}}
|
||
|
|
Use the [`time.Format`] function to format string representations of dates, and to format raw TOML dates that exclude time and time zone offset.
|
||
|
|
|
||
|
|
[`time.Format`]: /functions/time/format
|
||
|
|
{{% /note %}}
|
||
|
|
|
||
|
|
## Layout string
|
||
|
|
|
||
|
|
{{% include "functions/_common/time-layout-string.md" %}}
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
Given this front matter:
|
||
|
|
|
||
|
|
{{< code-toggle fm=true >}}
|
||
|
|
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.
|
||
|
|
|
||
|
|
```go-html-template
|
||
|
|
{{ $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`](/functions/inflect/humanize) function to render the day of the month as an ordinal number:
|
||
|
|
|
||
|
|
```go-html-template
|
||
|
|
{{ $t := "2023-01-27T23:44:58-08:00" }}
|
||
|
|
{{ $t = time.AsTime $t }}
|
||
|
|
|
||
|
|
{{ humanize $t.Day }} of {{ $t.Format "January 2006" }} → 27th of January 2023
|
||
|
|
```
|