hugo/docs/content/en/functions/fmt/Erroridf.md
2023-10-20 09:43:56 +02:00

1.4 KiB

title linkTitle description categories keywords menu function relatedFunctions aliases
fmt.Erroridf erroridf Log a suppressable ERROR from a template.
functions
docs
parent
functions
aliases returnType signatures
erroridf
string
fmt.Erroridf ID FORMAT [INPUT]
fmt.Errorf
fmt.Erroridf
fmt.Warnf
/functions/erroridf

The documentation for Go's fmt package describes the structure and content of the format string.

Like the errorf function, the erroridf function evaluates the format string, prints the result to the ERROR log, then fails the build. Hugo prints each unique message once to avoid flooding the log with duplicate errors.

Unlike the errorf function, you may suppress errors logged by the erroridf function by adding the message ID to the ignoreErrors array in your site configuration.

This template code:

{{ erroridf "error-42" "You should consider fixing this." }}

Produces this console log:

ERROR 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 = ["error-42"]

To suppress this message:

{{< code-toggle file=hugo copy=false >}} ignoreErrors = ["error-42"] {{< /code-toggle >}}