diff options
Diffstat (limited to 'docs/content/en/functions/strings/Substr.md')
-rw-r--r-- | docs/content/en/functions/strings/Substr.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/content/en/functions/strings/Substr.md b/docs/content/en/functions/strings/Substr.md new file mode 100644 index 000000000..9dafa0737 --- /dev/null +++ b/docs/content/en/functions/strings/Substr.md @@ -0,0 +1,42 @@ +--- +title: strings.Substr +linkTitle: substr +description: Extracts parts of a string from a specified character's position and returns the specified number of characters. +categories: [functions] +keywords: [] +menu: + docs: + parent: functions +function: + aliases: [substr] + returnType: string + signatures: ['strings.Substr STRING START [LENGTH]'] +relatedFunctions: [] +aliases: [/functions/substr] +--- + +It normally takes two argument: `start` and `length`. It can also take one argument: `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. + +If `length` is given and is negative, that number of characters will be omitted from the end of string. + +```go-html-template +{{ 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" +``` |