hugo/docs/content/en/templates/shortcode.md at 1158e6307212fd3ff96f29db0baf79463e0c031e

github/hugo

Fork 0

mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00

Bjørn Erik Pedersen 0c453420e6

Merge commit 'dec8cd4ada29218971743333f8ac662a9c06aad8'

2024-09-01 14:51:15 +02:00

16 KiB

Raw Blame History

title

linkTitle

description

Create custom shortcodes

Hugo's embedded shortcodes cover many common, but not all, use cases. Luckily, Hugo provides the ability to easily create custom shortcodes to meet your website's needs.

File location

To create a shortcode, place an HTML template in the layouts/shortcodes directory. Consider the file name carefully since the shortcode name will mirror that of the file but without the .html extension. For example, layouts/shortcodes/myshortcode.html will be called with either {{</* myshortcode /*/>}} or {{%/* myshortcode /*/%}}.

You can organize your shortcodes in subdirectories, e.g. in layouts/shortcodes/boxes. These shortcodes would then be accessible with their relative path, e.g:

{{</* boxes/square */>}}

Note the forward slash.

Template lookup order

Hugo selects shortcode templates based on the shortcode name, the current output format, and the current language. The examples below are sorted by specificity in descending order. The least specific path is at the bottom of the list.

Shortcode name	Output format	Language	Template path
foo	html	en	layouts/shortcodes/foo.en.html
foo	html	en	layouts/shortcodes/foo.html.html
foo	html	en	layouts/shortcodes/foo.html
foo	html	en	layouts/shortcodes/foo.html.en.html

Shortcode name	Output format	Language	Template path
foo	rss	en	layouts/shortcodes/foo.en.xml
foo	rss	en	layouts/shortcodes/foo.rss.xml
foo	rss	en	layouts/shortcodes/foo.en.html
foo	rss	en	layouts/shortcodes/foo.rss.en.xml
foo	rss	en	layouts/shortcodes/foo.xml
foo	rss	en	layouts/shortcodes/foo.html.en.html
foo	rss	en	layouts/shortcodes/foo.html.html
foo	rss	en	layouts/shortcodes/foo.html

Note that templates provided by a theme or module always take precedence.

Positional vs. named arguments

You can create shortcodes using the following types of arguments:

Positional arguments
Named arguments
Positional or named arguments

In shortcodes with positional arguments, the order of the arguments is important. If a shortcode has a single required value, positional arguments require less typing from content authors.

For more complex layouts with multiple or optional arguments, named arguments work best. While less terse, named arguments require less memorization from a content author and can be added in a shortcode declaration in any order.

Allowing both types of arguments is useful for complex layouts where you want to set default values that can be easily overridden by users.

Access arguments

All shortcode arguments can be accessed via the .Get method. Whether you pass a string or a number to the .Get method depends on whether you are accessing a named or positional argument, respectively.

To access an argument by name, use the .Get method followed by the named argument as a quoted string:

{{ .Get "class" }}

To access an argument by position, use the .Get followed by a numeric position, keeping in mind that positional arguments are zero-indexed:

{{ .Get 0 }}

For the second position, you would just use:

{{ .Get 1 }}

with is great when the output depends on a argument being set:

{{ with .Get "class" }} class="{{ . }}"{{ end }}

.Get can also be used to check if a argument has been provided. This is most helpful when the condition depends on either of the values, or both:

{{ if or (.Get "title") (.Get "alt") }} alt="{{ with .Get "alt" }}{{ . }}{{ else }}{{ .Get "title" }}{{ end }}"{{ end }}

`.Inner`

The .Inner method returns the content between the opening and closing shortcode tags. To check if .Inner returns anything other than whitespace:

{{ if strings.ContainsNonSpace .Inner }}
  Inner is not empty
{{ end }}

{{% note %}} Any shortcode that calls the .Inner method must be closed or self-closed. To call a shortcode using the self-closing syntax.

{{</* innershortcode /*/>}}

`.Params`

The .Params method in shortcodes returns the arguments passed to the shortcode for more complicated use cases. You can also access higher-scoped arguments with the following logic:

$.Params: these are the arguments passed directly into the shortcode declaration (e.g., a YouTube video ID)
$.Page.Params: refers to the page's parameters; the "page" in this case refers to the content file in which the shortcode is declared (e.g., a shortcode_color field in a content's front matter could be accessed via $.Page.Params.shortcode_color).
$.Site.Params: refers to parameters defined in your site configuration.

`.IsNamedParams`

The .IsNamedParams method checks whether the shortcode declaration uses named arguments and returns a boolean value.

For example, you could create an image shortcode that can take either a src named argument or the first positional argument, depending on the preference of the content's author. Let's assume the image shortcode is called as follows:

{{</* image src="images/my-image.jpg" */>}}

You could then include the following as part of your shortcode templating:

{{ if .IsNamedParams }}
  <img src="{{ .Get "src" }}" alt="">
{{ else }}
  <img src="{{ .Get 0 }}" alt="">
{{ end }}

See the example Vimeo shortcode below for .IsNamedParams in action.

{{% note %}} While you can create shortcode templates that accept both positional and named arguments, you cannot declare shortcodes in content with a mix of argument types. Therefore, a shortcode declared like {{</* image src="images/my-image.jpg" "This is my alt text" */>}} will return an error. {{% /note %}}

Shortcodes can also be nested. In a nested shortcode, you can access the parent shortcode context with the .Parent shortcode method. This can be very useful for inheritance from the root.

Checking for existence

You can check if a specific shortcode is used on a page by calling .HasShortcode in that page template, providing the name of the shortcode. This is useful when you want to include specific scripts or styles in the header that are only used by that shortcode.

Custom shortcode examples

The following are examples of the different types of shortcodes you can create via shortcode template files in /layouts/shortcodes.

Single-word example: `year`

Let's assume you would like to keep mentions of your copyright year current in your content files without having to continually review your Markdown. Your goal is to be able to call the shortcode as follows:

{{</* year */>}}

Single positional example: `youtube`

Embedded videos are a common addition to Markdown content. The following is the code used by Hugo's built-in YouTube shortcode:

{{</* youtube 09jf3ow9jfw */>}}

Would load the template at /layouts/shortcodes/youtube.html:

Single named example: `image`

Let's say you want to create your own img shortcode rather than use Hugo's built-in figure shortcode. Your goal is to be able to call the shortcode as follows in your content files:

You have created the shortcode at /layouts/shortcodes/img.html, which loads the following shortcode template:

{{ if isset .Params "title" }}
{{ .Get "title" }}
{{ end }} {{ if or (.Get "caption") (.Get "attr") }}
{{ .Get "caption" }} {{ with .Get "attrlink" }} {{ end }} {{ .Get "attr" }} {{ if .Get "attrlink" }} {{ end }}
{{ end }}

Would be rendered as:

Single flexible example: `vimeo`

{{</* vimeo 49718712 */>}}
{{</* vimeo id="49718712" class="flex-video" */>}}

Would load the template found at /layouts/shortcodes/vimeo.html:

Would be rendered as:

Paired example: `highlight`

The following is taken from highlight, which is a built-in shortcode that ships with Hugo.

<html> This HTML </html> {{}} {{< /code >}}

The template for the highlight shortcode uses the following code, which is already included in Hugo:

{{ .Get 0 | highlight .Inner }}

The rendered output of the HTML example code block will be as follows:

<html>
    <body> This HTML </body>
</html>

Nested shortcode: image gallery

Hugo's .Parent shortcode method provides access to the parent shortcode context when the shortcode in question is called within the context of a parent shortcode. This provides an inheritance model.

The following example is contrived but demonstrates the concept. Assume you have a gallery shortcode that expects one named class argument:

You also have an img shortcode with a single named src argument that you want to call inside of gallery and other shortcodes, so that the parent defines the context of each img:

{{< code file=layouts/shortcodes/img.html >}} {{- $src := .Get "src" -}} {{- with .Parent -}} <img src="{{ $src }}" class="{{ .Get "class" }}-image"> {{- else -}} {{- end -}} {{< /code >}}

You can then call your shortcode in your content as follows:

{{</* gallery class="content-gallery" */>}}
  {{</* img src="/images/one.jpg" */>}}
  {{</* img src="/images/two.jpg" */>}}
{{</* /gallery */>}}
{{</* img src="/images/three.jpg" */>}}

This will output the following HTML. Note how the first two img shortcodes inherit the class value of content-gallery set with the call to the parent gallery, whereas the third img only uses src:

<div class="content-gallery">
    <img src="/images/one.jpg" class="content-gallery-image">
    <img src="/images/two.jpg" class="content-gallery-image">
</div>
<img src="/images/three.jpg">

Error handling in shortcodes

Use the errorf template function with the Name and Position shortcode methods to generate useful error messages:

Hello, my name is {{ . }}.

{{ else }} {{ errorf "The %q shortcode requires a 'name' argument. See %s" .Name .Position }} {{ end }} {{< /code >}}

When the above fails, you will see an ERROR message such as:

ERROR The "greeting" shortcode requires a 'name' argument. See "/home/user/project/content/_index.md:12:1"

Inline shortcodes

You can also implement your shortcodes inline -- e.g. where you use them in the content file. This can be useful for scripting that you only need in one place.

This feature is disabled by default, but can be enabled in your site configuration:

{{< code-toggle file=hugo >}} [security] enableInlineShortcodes = true {{< /code-toggle >}}

It is disabled by default for security reasons. The security model used by Hugo's template handling assumes that template authors are trusted, but that the content files are not, so the templates are injection-safe from malformed input data. But in most situations you have full control over the content, too, and then enableInlineShortcodes = true would be considered safe. But it's something to be aware of: It allows ad-hoc Go Text templates to be executed from the content files.

And once enabled, you can do this in your content files:

{{</* time.inline */>}}{{ now }}{{</* /time.inline */>}}

The above will print the current date and time.

Note that an inline shortcode's inner content is parsed and executed as a Go text template with the same context as a regular shortcode template.

This means that the current page can be accessed via .Page.Title etc. This also means that there are no concept of "nested inline shortcodes".

The same inline shortcode can be reused later in the same content file, with different arguments if needed, using the self-closing syntax:

{{</* time.inline /*/>}}

16 KiB Raw Blame History

Create custom shortcodes

File location

Template lookup order

Positional vs. named arguments

Access arguments

.Inner

.Params

.IsNamedParams

Checking for existence

Custom shortcode examples

Single-word example: year

Single positional example: youtube

Single named example: image

{{ .Get "title" }}

Steve Francia

Single flexible example: vimeo

Paired example: highlight