hugo/docs/content/en/variables/shortcodes.md

1.7 KiB

title linktitle description date publishdate lastmod categories keywords draft menu weight sections_weight aliases toc
Shortcode Variables Shortcode Variables Shortcodes can access page variables and also have their own specific built-in variables. 2017-03-12 2017-03-12 2017-03-12
variables and params
shortcodes
false
docs
parent weight
variables 20
20 20
false

Shortcodes have access to parameters delimited in the shortcode declaration via .Get, page- and site-level variables, and also the following shortcode-specific fields:

.Name
Shortcode name.
.Ordinal
Zero-based ordinal in relation to its parent. If the parent is the page itself, this ordinal will represent the position of this shortcode in the page content.
.Parent
provides access to the parent shortcode context in nested shortcodes. This can be very useful for inheritance of common shortcode parameters from the root.
.Position
Contains filename and position for the shortcode in a page. Note that this can be relatively expensive to calculate, and is meant for error reporting. See Error Handling in Shortcodes.
.IsNamedParams
boolean that returns true when the shortcode in question uses named rather than positional parameters
.Inner
represents the content between the opening and closing shortcode tags when a closing shortcode is used