hugo/docs/content/en/methods/shortcode/Name.md
2024-06-21 09:41:24 +02:00

840 B

title description categories keywords action
Name Returns the shortcode file name, excluding the file extension.
related returnType signatures
methods/shortcode/Position
functions/fmt/Errorf
string
SHORTCODE.Name

The Name method is useful for error reporting. For example, if your shortcode requires a "greeting" argument:

{{< code file=layouts/shortcodes/myshortcode.html >}} {{ $greeting := "" }} {{ with .Get "greeting" }} {{ $greeting = . }} {{ else }} {{ errorf "The %q shortcode requires a 'greeting' argument. See %s" .Name .Position }} {{ end }} {{< /code >}}

In the absence of a "greeting" argument, Hugo will throw an error message and fail the build:

ERROR The "myshortcode" shortcode requires a 'greeting' argument. See "/home/user/project/content/about.md:11:1"