HUGO
News Docs Themes Community GitHub

Name

Returns the shortcode file name, excluding the file extension.

Syntax

SHORTCODE.Name

Returns

string

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

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

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"