stdWrap

When a data type is set to "type /stdWrap" it means that the value is parsed through the stdWrap function with the properties of the value as parameters.

Content-supplying properties of stdWrap

stdWrap contains properties which determine what is applied. The properties are listed below.

Note

The properties are parsed in the listed order. The properties data, field, current, cObject (in that order!) are special as they are used to import content from variables or arrays.

If you want to study this further please refer to typo3/sysext/frontend/Classes/ContentObject/ContentObjectRenderer.php, where you will find the function stdWrap() and the array $stdWrapOrder, which represents the exact order of execution.

Note that the stdWrap property "orderedStdWrap" allows you to execute multiple stdWrap functions in a freely selectable order.

The above example could be rewritten to this:

EXT:site_package/Configuration/TypoScript/setup.typoscript

10 = TEXT
10.value = some text
10.stdWrap.case = upper
10.stdWrap.field = header

Now the line 10.value = some text is obsolete, because the whole value is "imported" from the field called "header" from the $cObj->data-array.

Properties

Properties for getting data

setContentToCurrent

setContentToCurrent

Data type

boolean / stdWrap

Sets the current value to the incoming content of the function.

addPageCacheTags

addPageCacheTags

Data type

string / stdWrap

Comma-separated list of cache tags, which should be added to the page cache.

Examples

addPageCacheTags = pagetag1,pagetag2,pagetag3

This will add the tags "pagetag1", "pagetag2" and "pagetag3" to the according cached pages in cache_pages.

Pages, which have been cached with a tag, can be deleted from cache again with the TSconfig option TCEMAIN.clearCacheCmd.

Note

If you instead want to store rendered content into the caching framework, see the stdWrap feature cache.

setCurrent

setCurrent

Data type

string / stdWrap

Sets the "current"-value. This is normally set from some outside routine, so be careful with this. But it might be handy to do this

lang

lang

Data type

Array of language keys / stdWrap

This is used to define optional language specific values based on the current site language.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10 = TEXT
page.10.value = I am a Berliner!
page.10.stdWrap.lang.de = Ich bin ein Berliner!

Output will be "Ich bin..." instead of "I am..."

data

data

Data type

Data / getText / stdWrap

field

field

Data type

Field name / stdWrap

Sets the content to the value of the according field (which comes from $cObj->data[*field*]).

Note

$cObj->data changes depending on the context. See the description for the data type "Data / getText"/field!

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10.field = title

This sets the content to the value of the field "title".

You can also check multiple field names, if you divide them by "//".

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10.field = nav_title // title

Here the content from the field nav_title will be returned unless it is a blank string. If a blank string, the value of the title field is returned.

current

current

Data type

boolean / stdWrap

Sets the content to the "current"-value (see ->split)

cObject

cObject

Data type

Content Objects (cObject)

Loads content from a content object.

numRows

numRows

Data type

->numRows / stdWrap

Returns the number of rows resulting from the supplied SELECT query.

preUserFunc

preUserFunc

Data type

function name

Calls the provided PHP function. If you specify the name with a '->' in it, then it is interpreted as a call to a method in a class.

Two parameters are sent to the PHP function: As first parameter a content variable, which contains the current content. This is the value to be processed. As second parameter any sub-properties of preUserFunc are provided to the function.

See postUserFunc.

Properties for overriding and conditions

override

override

Data type

string / stdWrap

If override returns something else than "" or zero (trimmed), the content is loaded with this!

preIfEmptyListNum

preIfEmptyListNum

Data type

(as "listNum" below)

(as "listNum" below)

ifNull

ifNull

Data type

string / stdWrap

If the content is null (NULL type in PHP), the content is overridden with the value defined here.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10 = COA_INT
page.10 {
   10 = TEXT
   10 {
      stdWrap.field = description
      stdWrap.ifNull = No description defined.
   }
}

This example shows the content of the field description or, if that field contains the value NULL, the text "No description defined.".

ifEmpty

ifEmpty

Data type

string / stdWrap

If the trimmed content is empty at this point, the content is loaded with ifEmpty. Zeros are treated as empty values!

ifBlank

ifBlank

Data type

string / stdWrap

Same as ifEmpty but the check is done against ''. Zeros are not treated as blank values!

listNum

listNum

Data type

string / stdWrap

Explodes the current content listNum.splitChar (Default: ,) and returns the object specified by listNum.

Possible values:

last

The special keyword last is replaced with the index of the last element in the exploded content.

rand

The special keyword rand is replaced with the index of a random element in the exploded content.

Calc

After the special keywords are replaced with their according numeric values the

0 - last

If the content of listNum can be interpreted as integer the according index of the exploded content is returned. Counting starts with 0.

Examples

This would return "item 1":

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10 = TEXT
page.10.value = item 1, item 2, item 3, item 4
page.10.listNum = 0

This would return "item 3"

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10 = TEXT
page.10.value = item 1, item 2, item 3, item 4
page.10.listNum = last – 1

listNum.splitChar

Data type

string

Default

, (comma)

Examples

Splits the content of the field subtitle by the pipe character and returns a random element

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.5 = COA_INT
page.5 {
   10 = TEXT
   10 {
      stdWrap.field = subtitle
      stdWrap.listNum = rand
      stdWrap.listNum.splitChar = |
   }
}

trim

trim

Data type

boolean / stdWrap

If set, the PHP-function trim() will be used to remove whitespaces around the value.

strPad

strPad

Data type

strPad

Pads the current content to a certain length. You can define the padding characters and the side(s), on which the padding should be added.

stdWrap

stdWrap

Data type

stdWrap

Recursive call to the stdWrap function.

required

required

Data type

boolean / stdWrap

This flag requires the content to be set to some value after any content-import and treatment that might have happened until now (data, field, current, listNum, trim). Zero is not regarded as empty! Use "if" instead!

If the content is empty, "" is returned immediately.

if

if

Data type

if

If the if-object returns false, stdWrap returns "" immediately.

fieldRequired

fieldRequired

Data type

Field name / stdWrap

The value in this field must be set.

Properies for parsing data

csConv

csConv

Data type

string / stdWrap

Convert the charset of the string from the charset given as value to the current rendering charset of the frontend (UTF-8).

parseFunc

parseFunc

Data type

object path reference / parseFunc / stdWrap

Processing instructions for the content.

Note

If you enter a string as value, this will be taken as a reference to an object path globally in the TypoScript object tree. This will be the basis configuration for parseFunc merged with any properties you add here. It works exactly like references does for content elements.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10 {
    parseFunc = < lib.parseFunc_RTE
    parseFunc.tags.myTag = TEXT
    parseFunc.tags.myTag.value = This will be inserted when &lt;myTag&gt; is found!
}

Sanitization

New in version 9.5.29/10.4.19.

htmlSanitize is enabled by default when parseFunc is invoked. This also includes the Fluid Viewhelper <f:format.html>, since it invokes parseFunc directly using lib.parseFunc_RTE.

The following example shows how to disable the sanitization behavior that is enabled by default. This is not recommended, but it can be disabled when required.

EXT:site_package/Configuration/TypoScript/setup.typoscript

// either disable globally
lib.parseFunc.htmlSanitize = 0
lib.parseFunc_RTE.htmlSanitize = 0

// or disable individually per use case
10 = TEXT
10 {
    value = <div><img src="invalid.file" onerror="alert(1)"></div>
    parseFunc =< lib.parseFunc_RTE
    parseFunc.htmlSanitize = 0
}

Since any invocation of stdWrap.parseFunc triggers HTML sanitization automatically; unless explicitly disabled the following example causes a lot of generated markup to be sanitized and can be solved by explicitly disabling it with htmlSanitize = 0.

EXT:site_package/Configuration/TypoScript/setup.typoscript

10 = FLUIDTEMPLATE
10 {
    templateRootPaths {
        // ...
    }
    variables {
        // ...
    }
    stdWrap.parseFunc {
        // replace --- with soft-hyphen
        short.--- = ­
        // sanitization of ALL MARKUP is NOT DESIRED here
        htmlSanitize = 0
    }
}

HTMLparser

HTMLparser

Data type

boolean / HTMLparser / stdWrap

This object allows you to parse the HTML-content and perform all kinds of advanced filtering on the content.

Value must be set and properties are those of HTMLparser.

(See Rich text editors (RTE) for more information about RTE transformations)

split

split

Data type

split / stdWrap

replacement

replacement

Data type

replacement / stdWrap

Performs an ordered search/replace on the current content with the possibility of using PCRE regular expressions. An array with numeric indices defines the order of actions and thus allows multiple replacements at once.

prioriCalc

prioriCalc

Data type

boolean / stdWrap

Calculation of the value using operators -+*/%^ plus respects priority to + and - operators and parenthesis levels ().

. (period) is decimal delimiter.

Returns a doublevalue.

If prioriCalc is set to "intval" an integer is returned.

There is no error checking and division by zero or other invalid values may generate strange results. Also you should use a proper syntax because future modifications to the function used may allow for more operators and features.

Examples

Example Output for different calculations

100%7 = 2
-5*-4 = 20
+6^2 = 36
6 ^(1+1) = 36
-5*-4+6^2-100%7 = 54
-5 * (-4+6) ^ 2 - 100%7 = 98
-5 * ((-4+6) ^ 2) - 100%7 = -22

char

char

Data type

integer / stdWrap

Content is set to chr(*value*). This returns a one-character string containing the character specified by ascii code. Reliable results will be obtained only for character codes in the integer range 0 - 127. See the PHP manual:

$content = chr((int)$conf['char']);

intval

intval

Data type

boolean / stdWrap

PHP function intval() returns an integer:

$content = intval($content);

hash

hash

Data type

string / stdWrap

Returns a hashed value of the current content. Set to one of the algorithms which are available in PHP. For a list of supported algorithms see https://www.php.net/manual/en/function.hash-algos.php.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10 = TEXT
page.10 {
   value = test@example.org
   stdWrap.hash = md5
   stdWrap.wrap = <img src="https://www.gravatar.com/avatar/|" />
}

round

round

Data type

round / stdWrap

Round the value with the selected method to the given number of decimals.

numberFormat

numberFormat

Data type

numberFormat

Format a float value to any number format you need (e.g. useful for prices).

date

date

Data type

date-conf / stdWrap

The content should be data-type "UNIX-time". Returns the content formatted as a date. See the PHP manual (datetime.format) for the format codes.

$content = date($conf['date'], $content);

Properties:

.GMT: If set, the PHP function gmdate() will be used instead of date().

Examples

Render in human readable form:

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10 = TEXT
page.10.value {
   # format like 2017-05-31 09:08
   field = tstamp
   date = Y-m-d H:i
}

Note

You should consider using the more flexible function formattedDate.

strtotime

strtotime

Data type

string

Allows conversion of formatted dates to timestamp, e.g. to perform date calculations.

Possible values are 1 or any time string valid as first argument of the PHP strtotime() function.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

lib.date_as_timestamp = TEXT
lib.date_as_timestamp {
   value = 2015-04-15
   strtotime = 1
}

EXT:site_package/Configuration/TypoScript/setup.typoscript

lib.next_weekday = TEXT
lib.next_weekday {
   data = GP:selected_date
   strtotime = + 2 weekdays
   strftime = %Y-%m-%d
}

strftime

strftime

Data type

strftime-conf / stdWrap

Very similar to "date", but using a different format. See the PHP manual (strftime) for the format codes.

This formatting is useful if the locale is set in advance in the CONFIG object. See there.

Properties:

.charset

Can be set to the charset of the output string if you need to convert it to UTF-8. Default is to take the intelligently guessed charset from TYPO3\CMS\Core\Charset\CharsetConverter.

.GMT

If set, the PHP function gmstrftime() will be used instead of strftime().

Note

You should consider using the more flexible function formattedDate.

formattedDate

New in version 12.3.

formattedDate

Data type

string

The function renders date and time based on formats/patterns defined by the International Components for Unicode standard (ICU). ICU-based date and time formatting is much more flexible in rendering as date or strftime, as it ships with default patterns for date and time based on the given locale (given examples for locale en-US and timezone America/Los_Angeles):

• FULL, for example: Friday, March 17, 2023 at 3:00:00 AM Pacific Daylight Time

• LONG, for example: March 17, 2023 at 3:00:00 AM PDT

• MEDIUM, for example: Mar 17, 2023, 3:00:00 AM

• SHORT, for example: 3/17/23, 3:00 AM

TYPO3 also adds prepared custom patterns:

• FULLDATE, for example: Friday, March 17, 2023

• FULLTIME, for example: 3:00:00 AM Pacific Daylight Time

• LONGDATE, for example: March 17, 2023

• LONGTIME, for example: 3:00:00 AM PDT

• MEDIUMDATE, for example: Mar 17, 2023

• MEDIUMTIME, for example: 3:00:00 AM

• SHORTDATE, for example: 3/17/23

• SHORTTIME, for example: 3:00 AM

Note

You can specify an own pattern to suit your requirements, for example: qqqq, yyyy will result in 1st quarter, 2023. Have a look into the available options.

The locale is typically fetched from the locale setting in the site configuration.

Properties:

.locale

A locale other than the locale of the site language.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

lib.my_formatted_date = TEXT
lib.my_formatted_date {
    value = 2023-03-17 3:00:00
    formattedDate = FULL
    # Optional, if a different locale is wanted other than the site language's locale
    formattedDate.locale = de-DE
}

will result in "Freitag, 17. März 2023 um 03:00:00 Nordamerikanische Westküsten-Sommerzeit".

EXT:site_package/Configuration/TypoScript/setup.typoscript

lib.my_formatted_date = TEXT
lib.my_formatted_date {
    value = -5 days
    formattedDate = FULL
    formattedDate.locale = fr-FR
}

will result in "dimanche 12 mars 2023 à 11:16:44 heure d’été du Pacifique".

Note

The timezone will be taken from the setting date.timezone in your php.ini.

age

age

Data type

boolean or string / stdWrap

If enabled with a "1" (number, integer) the content is seen as a date (UNIX-time) and the difference from present time and the content-time is returned as one of these eight variations:

"xx min" or "xx hrs" or "xx days" or "xx yrs" or "xx min" or "xx hour" or "xx day" or "year"

The limits between which layout is used are 60 minutes, 24 hours and 365 days.

If you set this property with a non-integer, it is used to format the eight units. The first four values are the plural values and the last four are singular. This is the default string:

Default string for age format

min| hrs| days| yrs| min| hour| day| year

Set another string if you want to change the units. You may include the "-signs. They are removed anyway, but they make sure that a space which you might want between the number and the unit stays.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

lib.ageFormat = TEXT
lib.ageFormat.stdWrap.data = page:tstamp
lib.ageFormat.stdWrap.age = " Minuten | Stunden | Tage | Jahre | Minute | Stunde | Tag | Jahr"

case

case

Data type

case / stdWrap

Converts case

Uses "UTF-8" for the operation.

bytes

bytes

Data type

boolean / stdWrap

Default

iec, 1024

This is for number values. When the 'bytes' property is added and set to 'true' then a number will be formatted in 'bytes' style with two decimals like '1.53 KiB' or '1.00 MiB'. Learn about common notations at Wikipedia "Kibibyte". IEC naming with base 1024 is the default. Use sub-properties for customisation.

.labels = iec

This is the default. IEC labels and base 1024 are used. Built in IEC labels are " | Ki| Mi| Gi| Ti| Pi| Ei| Zi| Yi". You need to append a final string like 'B' or '-Bytes' yourself.

.labels = si

In this case SI labels and base 1000 are used. Built in IEC labels are " | k| M| G| T| P| E| Z| Y". You need to append a final string like 'B' yourself.

.labels = "..."

Custom values can be defined as well like with .labels = " Byte| Kilobyte| Megabyte| Gigabyte". Use a vertical bar to separate the labels. Enclose the whole string in double quotes.

.base = 1000

Only with custom labels you can choose to set a base of1000. All other values, including the default, mean base 1024.

Attention

If the value isn't a number the internal PHP function may issue a warning which - depending on you error handling settings - can interrupt execution. Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10 {
   value = abc
   bytes = 1
}

will show `0` but may raise a warning or an exception.

Examples

Output value 1000 without special formatting. Shows 1000:

EXT:site_package/Configuration/TypoScript/setup.typoscript

page = PAGE
page.10 = TEXT
page.10 {
   value = 1000
}

Format value 1000 in IEC style with base=1024. Shows 0.98 Ki:

EXT:site_package/Configuration/TypoScript/setup.typoscript

page = PAGE
page.10 = TEXT
page.10 {
   value = 1000
   bytes = 1
}

Format value 1000 in IEC style with base=1024 and 'B' supplied by us. Shows 0.98 KiB:

EXT:site_package/Configuration/TypoScript/setup.typoscript

page = PAGE
page.10 = TEXT
page.10 {
   value = 1000
   bytes = 1
   noTrimWrap = ||B|
}

Format value 1000 in SI style with base=1000. Shows 1.00 k:

EXT:site_package/Configuration/TypoScript/setup.typoscript

page = PAGE
page.10 = TEXT
page.10 {
   value = 1000
   bytes = 1
   bytes.labels = si
}

Format value 1000 in SI style with base=1000 and 'b' supplied by us. Shows 1.00 kb:

EXT:site_package/Configuration/TypoScript/setup.typoscript

page = PAGE
page.10 = TEXT
page.10 {
   value = 1000
   bytes = 1
   bytes.labels = si
   noTrimWrap = ||b|
}

Format value 1000 with custom label and base=1000. Shows 1.00 x 1000 Bytes:

EXT:site_package/Configuration/TypoScript/setup.typoscript

page = PAGE
page.10 = TEXT
page.10 {
   value = 1000
   bytes = 1
   bytes.labels = " x 1 Byte| x 1000 Bytes"
   bytes.base = 1000
}

Format value 1000 with custom label and base=1000. Shows 1.00 kilobyte (kB):

EXT:site_package/Configuration/TypoScript/setup.typoscript

page = PAGE
page.10 = TEXT
page.10 {
   value = 1000
   bytes = 1
   bytes.labels = " byte (B)| kilobyte (kB)| megabyte (MB)| gigabyte (GB)| terabyte (TB)| petabyte (PB)| exabyte (EB)| zettabyte (ZB)| yottabyte YB"
   bytes.base = 1000
}

Format value 1000 with custom label and base=1024. Shows 0.98 kibibyte (KiB):

EXT:site_package/Configuration/TypoScript/setup.typoscript

page = PAGE
page.10 = TEXT
page.10 {
   value = 1000
   bytes = 1
   bytes.labels = " byte (B)| kibibyte (KiB)| mebibyte (MiB)| gibibyte (GiB)| tebibyte (TiB)| pepibyte (PiB)| exbibyte (EiB)| zebibyte (ZiB)| yobibyte YiB"
   bytes.base = 1024
}

substring

substring

Data type

[p1], [p2] / stdWrap

Returns the substring with [p1] and [p2] sent as the 2nd and 3rd parameter to the PHP mb_substr function.

Uses "UTF-8" for the operation.

cropHTML

cropHTML

Data type

string / stdWrap

Crops the content to a certain length. In contrast to stdWrap.crop it respects HTML tags. It does not crop inside tags and closes open tags. Entities (like ">") are counted as one char. See stdWrap.crop below for a syntax description and examples.

Note that stdWrap.crop should not be used if stdWrap.cropHTML is already used.

stripHtml

stripHtml

Data type

boolean / stdWrap

Strips all HTML tags.

crop

crop

Data type

string / stdWrap

Crops the content to a certain length.

You can define up to three parameters, of which the third one is optional. The syntax is: [numbers of characters to keep] | [ellipsis] | [keep whole words]

numbers of characters to keep (integer): Define the number of characters you want to keep. For positive numbers, the first characters from the beginning of the string will be kept, for negative numbers the last characters from the end will be kept.

ellipsis (string): The signs to be added instead of the part, which was cropped of. If the number of characters was positive, the string will be prepended with the ellipsis, if it was negative, the string will be appended with the ellipsis.

keep whole words (boolean): If set to 0 (default), the string is always cropped directly after the defined number of characters. If set to 1, only complete words are kept. Then a word, which would normally be cut in the middle, is removed completely.

Examples

20 | ... => max 20 characters. If more, the value will be truncated to the first 20 characters and prepended with "..."

-20 | ... => max 20 characters. If more, the value will be truncated to the last 20 characters and appended with "..."

20 | ... | 1 => max 20 characters. If more, the value will be truncated to the first 20 characters and prepended with "...". If the division is in the middle of a word, the remains of that word is removed.

Uses "UTF-8" for the operation.

rawUrlEncode

rawUrlEncode

Data type

boolean / stdWrap

Passes the content through the PHP function rawurlencode().

htmlSpecialChars

htmlSpecialChars

Data type

boolean / stdWrap

Passes the content through the PHP function htmlspecialchars().

Additional property preserveEntities will preserve entities so only non-entity characters are affected.

encodeForJavaScriptValue

encodeForJavaScriptValue

Data type

boolean / stdWrap

Encodes content to be used safely inside strings in JavaScript. Characters, which can cause problems inside JavaScript strings, are replaced with their encoded equivalents. The resulting string is already quoted with single quotes.

Passes the content through the core function \TYPO3\CMS\Core\Utility\GeneralUtility::quoteJSvalue.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

10 = TEXT
10.stdWrap {
      data = GP:sWord
      encodeForJavaScriptValue = 1
      wrap = setSearchWord(|);
}

doubleBrTag

doubleBrTag

Data type

string / stdWrap

All double-line-breaks are substituted with this value.

br

br

Data type

boolean / stdWrap

Pass the value through the PHP function nl2br(). This converts each line break to a <br /> or a <br> tag depending on doctype.

brTag

brTag

Data type

string / stdWrap

All ASCII codes of "10" (line feed, LF) are substituted with the value, which has been provided in this property.

encapsLines

encapsLines

Data type

encapsLines / stdWrap

Lets you split the content by chr(10) and process each line independently. Used to format content made with the RTE.

keywords

keywords

Data type

boolean / stdWrap

Splits the content by characters "," ";" and php:chr(10) (return), trims each value and returns a comma-separated list of the values.

innerWrap

innerWrap

Data type

wrap / stdWrap

Wraps the content.

innerWrap2

innerWrap2

Data type

wrap / stdWrap

Same as innerWrap (but watch the order in which they are executed).

preCObject

preCObject

Data type

Content Objects (cObject)

cObject prepended the content.

postCObject

postCObject

Data type

Content Objects (cObject)

cObject appended the content.

wrapAlign

wrapAlign

Data type

align / stdWrap

Wraps content with <div style=text-align:[*value*];"> | </div> if align is set.

typolink

typolink

Data type

typolink / stdWrap

Wraps the content with a link-tag.

wrap

wrap

Data type

wrap /+.splitChar / stdWrap

splitChar defines an alternative splitting character (default is "|" - the vertical line)

noTrimWrap

noTrimWrap

Data type

"special" wrap /+.splitChar / stdWrap

This wraps the content without trimming the values. That means that surrounding whitespaces stay included! Note that this kind of wrap does not only need a special character in the middle, but that it also needs the same special character to begin and end the wrap (default for all three is "|").

Additional property:

splitChar

Can be set to define an alternative special character. stdWrap is available. Default is "|" - the vertical line. This sub-property is useful in cases when the default special character would be recognized by optionSplit (which takes precedence over noTrimWrap).

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10.noTrimWrap = | val1 | val2 |

In this example the content with the values val1 and val2 will be wrapped; including the whitespaces.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10 {
   noTrimWrap = ^ val1 ^ val2 ^ || ^ val3 ^ val4 ^
   noTrimWrap.splitChar = ^
}

optionSplit will use the "||" to have two subparts in the first part. In each subpart noTrimWrap will then use the "^" as special character.

wrap2

wrap2

Data type

wrap /+.splitChar / stdWrap

same as wrap (but watch the order in which they are executed)

dataWrap

dataWrap

Data type

mixed / stdWrap

The content is parsed for pairs of curly braces. The content of the curly braces is of the type Data / getText and is substituted with the result of Data / getText.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

page.10.dataWrap = <div id="{tsfe : id}"> | </div>

This will produce a <div> tag around the content with an id attribute that contains the number of the current page.

prepend

prepend

Data type

Content Objects (cObject)

cObject prepended to content (before)

append

append

Data type

Content Objects (cObject)

cObject appended to content (after)

wrap3

wrap3

Data type

wrap /+.splitChar / stdWrap

same as wrap (but watch the order in which they are executed)

orderedStdWrap

orderedStdWrap

Data type

Array of numeric keys with / stdWrap each

Execute multiple stdWrap statements in a freely selectable order. The order is determined by the numeric order of the keys. This allows to use multiple stdWrap statements without having to remember the rather complex sorting order in which the stdWrap functions are executed.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

10 = TEXT
10.value = a
10.stdWrap.orderedStdWrap {
   30.wrap = |.

   10.wrap = is | working
   10.innerWrap =  | 

   20.wrap = This|solution
   20.stdWrap.wrap =  | 
}

In this example orderedStdWrap is executed on the value "a". 10.innerWrap is executed first, followed by 10.wrap. Then the next key is processed which is 20. Afterwards 30.wrap is executed on what already was created.

This results in "This is a working solution."

outerWrap

outerWrap

Data type

wrap / stdWrap

Wraps the complete content

insertData

insertData

Data type

boolean / stdWrap

If set, then the content string is parsed like dataWrap above.

Examples

Displays the page title:

EXT:site_package/Configuration/TypoScript/setup.typoscript

10 = TEXT
10.value = This is the page title: {page:title}
10.stdWrap.insertData = 1

# TEXT is already stdWrapable, so we can also use insertData right away
20 = TEXT
20.value = <link rel="preload" href="{path : EXT:site/Resources/Public/Fonts/Roboto.woff2}" as="font" type="font/woff2" crossorigin="anonymous">
20.insertData = 1

Warning

Never use this on content that can be edited in the backend. This allows editors to disclose normally hidden information. Never use this to insert data into wraps. Use dataWrap instead.

postUserFunc

postUserFunc

Data type

function name

Calls the provided PHP function. If you specify the name with a '->' in it, then it is interpreted as a call to a method in a class.

Two parameters are sent to the PHP function: As first parameter a content variable, which contains the current content. This is the value to be processed. As second parameter any sub-properties of postUserFunc are provided to the function.

The description of the cObject USER contains some more in-depth information.

Examples

You can paste this example directly into a new template record:

EXT:site_package/Configuration/TypoScript/setup.typoscript

page = PAGE
page.typeNum = 0

page.10 = TEXT
page.10 {
   value = Hello World!
   stdWrap.postUserFunc = Vendor\SitePackage\UserFunctions\YourClass->reverseString
   stdWrap.postUserFunc.uppercase = 1
}

page.20 = TEXT
page.20 {
   value = Hello World!
   stdWrap.postUserFunc = Vendor\SitePackage\UserFunctions\YourClass->reverseString
   stdWrap.postUserFunc.uppercase = 1
   stdWrap.postUserFunc.typolink = 11
}

Your methods will get the parameters $content and $conf (in that order) and need to return a string.

EXT:site_package/Classes/UserFunctions/YourClass.php

namespace Vendor\SitePackage\UserFunctions;

/**
 * Example of a method in a PHP class to be called from TypoScript
 */
final class YourClass
{
   /*
    * Reference to the parent (calling) cObject set from TypoScript
    *
    * @var ContentObjectRenderer
    */
   private $cObj;

   public function setContentObjectRenderer(ContentObjectRenderer $cObj): void
   {
       $this->cObj = $cObj;
   }

   /**
    * Custom method for data processing. Also demonstrates how this gives us the
    * ability to use methods in the parent object.
    *
    * @param  string When custom methods are used for data processing (like in stdWrap functions), the $content variable will hold the value to be processed. When methods are meant to return some generated content (like in USER and USER_INT objects), this variable is empty.
    * @param  array  TypoScript properties passed to this method.
    * @return string The input string reversed. If the TypoScript property "uppercase" was set, it will also be in uppercase. May also be linked.
    */
   public function reverseString(string $content, array $conf): string
   {
      $content = strrev($content);
      if (isset($conf['uppercase']) && $conf['uppercase'] === '1') {
         // Use the method caseshift() from ContentObjectRenderer
         $content = $this->cObj->caseshift($content, 'upper');
      }
      if (isset($conf['typolink'])) {
         // Use the method typoLink() from ContentObjectRenderer
         $content = $this->cObj->typoLink($content, ['parameter' => $conf['typolink']]);
      }
      return $content;
   }
}

For page.10 the content, which is present when postUserFunc is executed, will be given to the PHP function reverseString(). The result will be !DLROW OLLEH.

The content of page.20 will be processed by the function reverseString() from the class YourClass. This also returns the text !DLROW OLLEH, but wrapped into a link to the page with the ID 11. The result will be <a href="/path/to/page/id/11">!DLROW OLLEH</a>.

Note how in the second example $this->cObj, the reference to the calling cObject, is utilised to use functions from ContentObjectRenderer class!

postUserFuncInt

postUserFuncInt

Data type

function name

Calls the provided PHP function. If you specify the name with a '->' in it, then it is interpreted as a call to a method in a class.

Two parameters are sent to the PHP function: As first parameter a content variable, which contains the current content. This is the value to be processed. As second parameter any sub-properties of postUserFuncInt are provided to the function.

The result will be rendered non-cached, outside the main page-rendering. Please see the description of the cObject USER_INT.

Supplied by Jens Ellerbrock

prefixComment

prefixComment

Data type

string / stdWrap

Prefixes content with an HTML comment with the second part of input string (divided by "|") where first part is an integer telling how many trailing tabs to put before the comment on a new line.

The content is parsed through insertData.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

prefixComment = 2 | CONTENT ELEMENT, uid:{field:uid}/{field:CType}

Will indent the comment with 1 tab (and the next line with 2+1 tabs)

htmlSanitize

htmlSanitize

Data type

boolean / array with key "build"

The property controls the sanitization and removal of XSS from markup. It strips tags, attributes and values that are not explicitly allowed.

• htmlSanitize = [boolean]: whether to invoke sanitization (enabled per default when invoked via stdWrap.parseFunc).

• htmlSanitize.build = [string]: defines which specific builder (must be an instance of \TYPO3\HtmlSanitizer\Builder\BuilderInterface) to be used for building a \TYPO3\HtmlSanitizer\Sanitizer instance using a particular \TYPO3\HtmlSanitizer\Behavior. This can either be a fully qualified class name or the name of a preset as defined in $GLOBALS['TYPO3_CONF_VARS']['SYS']['htmlSanitizer'] - per default, \TYPO3\CMS\Core\Html\DefaultSanitizerBuilder is used.

Examples

EXT:site_package/Configuration/TypoScript/setup.typoscript

10 = TEXT
10 {
    value = <div><img src="invalid.file" onerror="alert(1)"></div>
    htmlSanitize = 1
}

will result in the following output:

<div><img src="invalid.file"></div>

The following code is equivalent to above, but with a builder specified:

EXT:site_package/Configuration/TypoScript/setup.typoscript

10 = TEXT
10 {
    value = <div><img src="invalid.file" onerror="alert(1)"></div>
    htmlSanitize = 1
    // Use either "default" for the default builder
    htmlSanitize.build = default
    // or use the full class name of the default builder
    // htmlSanitize.build = TYPO3\CMS\Core\Html\DefaultSanitizerBuilder
}

cache

cache

Data type

cache

Caches rendered content in the caching framework.

debug

debug

Data type

boolean / stdWrap

Prints content with HTMLSpecialChars() and <pre></pre>: Useful for debugging which value stdWrap actually ends up with, if you are constructing a website with TypoScript.

Attention

Only for debugging during development, otherwise output can break.

debugFunc

debugFunc

Data type

boolean / stdWrap

Prints the content directly to browser with the debug() function.

Set to value "2" the content will be printed in a table which looks nicer.

Attention

Only for debugging during development, otherwise output can break.

debugData

debugData

Data type

boolean / stdWrap

Prints the current data-array, $cObj->data, directly to browser. This is where field gets data from.

Attention

Only for debugging during development, otherwise output can break.

Example

Example with the property "value" of the content object "TEXT":

EXT:site_package/Configuration/TypoScript/setup.typoscript

10 = TEXT
10.value = some text
10.stdWrap.case = upper

Here the content of the object "10" is uppercased before it is returned.