hugo/docs/content/en/functions/fmt/Warnidf.md
2024-06-21 09:41:24 +02:00

1.1 KiB

title description categories keywords action aliases
fmt.Warnidf Log a suppressible WARNING from a template.
aliases related returnType signatures
warnidf
functions/fmt/Errorf
functions/fmt/Erroridf
functions/fmt/Warnf
string
fmt.Warnidf ID FORMAT [INPUT]
/functions/warnidf

{{< new-in 0.123.0 >}}

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

The warnidf function evaluates the format string, then prints the result to the WARNING log. Unlike the warnf function, you may suppress warnings logged by the warnidf function by adding the message ID to the ignoreLogs array in your site configuration.

This template code:

{{ warnidf "warning-42" "You should consider fixing this." }}

Produces this console log:

WARN You should consider fixing this.
You can suppress this warning by adding the following to your site configuration:
ignoreLogs = ['warning-42']

To suppress this message:

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