mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
bd77f6e1c9
327003421 Update index.md cafdccc13 Hugo 0.86.1 467a89a02 Merge branch 'v0861' a22c37bc9 Merge branch 'release-0.86.1' 276da91a8 releaser: Add release notes to /docs for release of 0.86.1 198cdf8f0 tpl/lang: Add new localized versions of lang.FormatNumber etc. 93f986ecc Add timezone support for front matter dates without one b30b876bb Localize time.Format 950fdab90 Fix AddDate documentation 78d7b52b6 Document config.cascade fd1e1e4b7 Fix grammar and spelling (#1497) 05bf3aa32 Fix grammar / typos in news 32060a3b4 One more try f6e24ddfa PNG to JPG for the rel notes image 9ec5bdfad Update index.md 5f5d7f69d Release Hugo 0.86.0 2dd60bb71 releaser: Add release notes to /docs for release of 0.86.0 6445fb36c Merge commit '53a352795a69a9d4a373f50ec62138595948c6ea' cb57ca73a Simplify "active menu" logic for section menus git-subtree-dir: docs git-subtree-split: 327003421d8c07f9764aaaf644626805287fd30c
63 lines
2.3 KiB
Markdown
63 lines
2.3 KiB
Markdown
---
|
|
title: time
|
|
linktitle:
|
|
description: Converts a timestamp string into a `time.Time` structure.
|
|
godocref:
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-02-01
|
|
categories: [functions]
|
|
menu:
|
|
docs:
|
|
parent: "functions"
|
|
keywords: [dates,time,location]
|
|
signature: ["time INPUT [TIMEZONE]"]
|
|
workson: []
|
|
hugoversion: "v0.77.0"
|
|
relatedfuncs: []
|
|
deprecated: false
|
|
aliases: []
|
|
---
|
|
|
|
|
|
`time` converts a timestamp string with an optional default location into a [`time.Time`](https://godoc.org/time#Time) structure so you can access its fields:
|
|
|
|
```
|
|
{{ time "2016-05-28" }} → "2016-05-28T00:00:00Z"
|
|
{{ (time "2016-05-28").YearDay }} → 149
|
|
{{ mul 1000 (time "2016-05-28T10:30:00.00+10:00").Unix }} → 1464395400000, or Unix time in milliseconds
|
|
```
|
|
|
|
## Using Locations
|
|
|
|
The optional `TIMEZONE` parameter is a string that sets a default time zone (or more specific, the location, which represents the collection of time offsets in a geographical area) that is associated with the specified time value. If the time value has an explicit timezone or offset specified, it will take precedence over the `TIMEZONE` parameter.
|
|
|
|
The list of valid locations may be system dependent, but should include `UTC`, `Local`, or any location in the [IANA Time Zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
|
|
If no `TIMEZONE` is set, the `timeZone` from site configuration will be used.
|
|
|
|
```
|
|
{{ time "2020-10-20" }} → 2020-10-20 00:00:00 +0000 UTC
|
|
{{ time "2020-10-20" "America/Los_Angeles" }} → 2020-10-20 00:00:00 -0700 PDT
|
|
{{ time "2020-01-20" "America/Los_Angeles" }} → 2020-01-20 00:00:00 -0800 PST
|
|
```
|
|
|
|
## Example: Using `time` to get Month Index
|
|
|
|
The following example takes a UNIX timestamp---set as `utimestamp: "1489276800"` in a content's front matter---converts the timestamp (string) to an integer using the [`int` function][int], and then uses [`printf`][] to convert the `Month` property of `time` into an index.
|
|
|
|
The following example may be useful when setting up [multilingual sites][multilingual]:
|
|
|
|
{{< code file="unix-to-month-integer.html" >}}
|
|
{{$time := time (int .Params.addDate)}}
|
|
=> $time = 1489276800
|
|
{{$time.Month}}
|
|
=> "March"
|
|
{{$monthindex := printf "%d" $time.Month }}
|
|
=> $monthindex = 3
|
|
{{< /code >}}
|
|
|
|
|
|
[int]: /functions/int/
|
|
[multilingual]: /content-management/multilingual/
|
|
[`printf`]: /functions/printf/
|