1
0
Fork 0
hugo/docs/content/en/functions/strings/Substr.md

1.2 KiB

title description categories keywords action aliases
strings.Substr Returns a substring of the given string, beginning with the start position and ending after the given length.
aliases related returnType signatures
substr
functions/strings/SliceString
string
strings.Substr STRING [START] [LENGTH]
/functions/substr

The start position is zero-based, where 0 represents the first character of the string. If START is not specified, the substring will begin at position 0. Specify a negative START position to extract characters from the end of the string.

If LENGTH is not specified, the substring will include all characters from the START position to the end of the string. If negative, that number of characters will be omitted from the end of string.

{{ substr "abcdef" 0 }} → abcdef
{{ substr "abcdef" 1 }} → bcdef

{{ substr "abcdef" 0 1 }} → a
{{ substr "abcdef" 1 1 }} → b

{{ substr "abcdef" 0 -1 }} → abcde
{{ substr "abcdef" 1 -1 }} → bcde

{{ substr "abcdef" -1 }} → f
{{ substr "abcdef" -2 }} → ef

{{ substr "abcdef" -1 1 }} → f
{{ substr "abcdef" -2 1 }} → e

{{ substr "abcdef" -3 -1 }} → de
{{ substr "abcdef" -3 -2 }} → d