diff options
Diffstat (limited to 'docs/content/en/functions/AddDate.md')
| -rw-r--r-- | docs/content/en/functions/AddDate.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/content/en/functions/AddDate.md b/docs/content/en/functions/AddDate.md new file mode 100644 index 000000000..7f5b39b16 --- /dev/null +++ b/docs/content/en/functions/AddDate.md @@ -0,0 +1,41 @@ +--- +title: .AddDate +description: Returns the time corresponding to adding the given number of years, months, and days to the given time.Time value. +categories: [functions] +keywords: [] +menu: + docs: + parent: functions +function: + aliases: [] + returnType: time.Time + signatures: [.AddDate YEARS MONTHS DAYS] +relatedFunctions: [] +--- + +```go-html-template +{{ $d := "2022-01-01" | time.AsTime }} + +{{ $d.AddDate 0 0 1 | time.Format "2006-01-02" }} → 2022-01-02 +{{ $d.AddDate 0 1 1 | time.Format "2006-01-02" }} → 2022-02-02 +{{ $d.AddDate 1 1 1 | time.Format "2006-01-02" }} → 2023-02-02 + +{{ $d.AddDate -1 -1 -1 | time.Format "2006-01-02" }} → 2020-11-30 +``` + +{{% note %}} +When adding months or years, Hugo normalizes the final `time.Time` value if the resulting day does not exist. For example, adding one month to 31 January produces 2 March or 3 March, depending on the year. + +See [this explanation](https://github.com/golang/go/issues/31145#issuecomment-479067967) from the Go team. +{{% /note %}} + +```go-html-template +{{ $d := "2023-01-31" | time.AsTime }} +{{ $d.AddDate 0 1 0 | time.Format "2006-01-02" }} → 2023-03-03 + +{{ $d := "2024-01-31" | time.AsTime }} +{{ $d.AddDate 0 1 0 | time.Format "2006-01-02" }} → 2024-03-02 + +{{ $d := "2024-02-29" | time.AsTime }} +{{ $d.AddDate 1 0 0 | time.Format "2006-01-02" }} → 2025-03-01 +``` |