mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
31 lines
994 B
Markdown
31 lines
994 B
Markdown
---
|
|
title: substr
|
|
# linktitle:
|
|
description: Extracts parts of a string from a specified character's position and returns the specified number of characters.
|
|
godocref:
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-02-01
|
|
categories: [functions]
|
|
menu:
|
|
docs:
|
|
parent: "functions"
|
|
#tags: [strings]
|
|
aliases: []
|
|
signature: ["substr STRING START [LENGTH]"]
|
|
workson: []
|
|
hugoversion:
|
|
relatedfuncs: []
|
|
deprecated: 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 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"
|
|
```
|