mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
---
|
|
title: errorf and warnf
|
|
description: Log ERROR or WARNING from the templates.
|
|
date: 2017-09-30
|
|
publishdate: 2017-09-30
|
|
lastmod: 2017-09-30
|
|
categories: [functions]
|
|
menu:
|
|
docs:
|
|
parent: "functions"
|
|
keywords: [strings, log, error]
|
|
signature: ["errorf FORMAT INPUT"]
|
|
workson: []
|
|
hugoversion:
|
|
relatedfuncs: [printf]
|
|
deprecated: false
|
|
---
|
|
|
|
`errorf` or `warnf` will evaluate a format string, then output the result to the ERROR or WARNING log (and only once per error message to avoid flooding the log).
|
|
|
|
Any ERROR will also cause the build to fail (the `hugo` command will `exit -1`).
|
|
|
|
Both functions return an empty string, so the messages are only printed to the console.
|
|
|
|
```
|
|
{{ errorf "Failed to handle page %q" .Path }}
|
|
```
|
|
|
|
```
|
|
{{ warnf "You should update the shortcodes in %q" .Path }}
|
|
```
|
|
|
|
Note that `errorf` and `warnf` support all the formatting verbs of the [fmt](https://golang.org/pkg/fmt/) package.
|
|
|
|
## Suppress errors
|
|
|
|
Some times it may make sense to let the user suppress an ERROR and make the build succeed.
|
|
|
|
You can do this by using the `erroridf` function. This functions takes an error ID as the first arument.
|
|
|
|
|
|
``
|
|
{{ erroridf "my-custom-error" "You should consider fixing this."}}
|
|
```
|
|
|
|
This will produce:
|
|
|
|
```
|
|
ERROR 2021/06/07 17:47:38 You should consider fixing this.
|
|
If you feel that this should not be logged as an ERROR, you can ignore it by adding this to your site config:
|
|
ignoreErrors = ["my-custom-error"]
|
|
```
|