mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-21 21:35:28 +02:00
Merge commit 'e509cac533600cf4fa8382c9cdab78ddd82db688'
This commit is contained in:
42
docs/content/en/functions/strings/Substr.md
Normal file
42
docs/content/en/functions/strings/Substr.md
Normal file
@@ -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"
|
||||
```
|
Reference in New Issue
Block a user