hugo/content/en/functions/substr.md
Bjørn Erik Pedersen b9bd35d72e Squashed 'docs/' content from commit fdea5430f
git-subtree-dir: docs
git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 10:22:28 +02:00

998 B

title description godocref date publishdate lastmod categories menu keywords aliases signature workson hugoversion relatedfuncs deprecated
substr Extracts parts of a string from a specified character's position and returns the specified number of characters. 2017-02-01 2017-02-01 2017-02-01
functions
docs
parent
functions
strings
substr STRING START [LENGTH]
false

It normally takes two parameters: start and length. It can also take one parameter: start, i.e. length is omitted, in which case the substring starting from start until the end of the string will be returned.

To extract characters from the end of the string, use a negative start number.

In addition, borrowing from the extended behavior described at https://php.net substr, if length is given and is negative, that number of characters will be omitted from the end of string.

{{substr "BatMan" 0 -3}} → "Bat"
{{substr "BatMan" 3 3}} → "Man"