Attention

TYPO3 v11 has reached end-of-life as of October 31th 2024 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.

Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v10 here: TYPO3 ELTS.

strPad

This property returns the input value padded to a certain length. The padding is added on the left side, the right side or on both sides. strPad uses the PHP function str_pad() for the operation.

Properties

length

Property: length
Data type: integer / stdWrap
Description: The length of the output string. If the value is negative, less than, or equal to the length of the input value, no padding takes place.
Default: 0

padWith

Property: padWith
Data type: string / stdWrap
Description: The character(s) to pad with. The value of padWith may be truncated, if the required number of padding characters cannot be evenly divided by the length of the value of padWith. Note that leading and trailing spaces of padWith are stripped! If you want to pad with spaces, omit this option.
Default: (space character)

type

Property: type
Data type: (list of keywords) / stdWrap
Description: The side(s) of the input value, on which the padding should be added. Possible keywords are "left", "right" or "both".
Default: right

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

10 = TEXT
# The input value is 34 signs long.
10.value = TYPO3 - inspiring people to share.
10.value.strPad {
     length = 37
     padWith = =
     type = both
}

This results in "=TYPO3 - inspiring people to share.==".