Files
hugo/content/functions/substr.md
T
2017-02-26 19:27:05 -06:00

1.0 KiB

title, linktitle, description, godocref, date, publishdate, lastmod, categories, tags, aliases, signature, workson, hugoversion, relatedfuncs, deprecated
title linktitle description godocref date publishdate lastmod categories tags 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
strings
false

substr extracts parts of a string, beginning at the character at the specified position, and returns the specified number of characters.

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 http://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"