1
0
Fork 0
hugo/docs/content/en/functions/fmt/Erroridf.md

1.0 KiB

title description categories keywords params aliases
fmt.Erroridf Log a suppressible ERROR from a template.
functions_and_methods
aliases returnType signatures
erroridf
string
fmt.Erroridf ID FORMAT [INPUT]
/functions/erroridf

{{% include "/_common/functions/fmt/format-string.md" %}}

The erroridf function evaluates the format string, then prints the result to the ERROR log and fails the build. Unlike the errorf function, you may suppress errors logged by the erroridf function by adding the message ID to the ignoreLogs 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.
You can suppress this error by adding the following to your site configuration:
ignoreLogs = ['error-42']

To suppress this message:

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