mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
b9bd35d72e
git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
1.7 KiB
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 |
|
|
false |
|
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