stdWrap 

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

Comma-separated list of cache tags to tag pages in the page cache.

addPageCacheTags = pagetag1,pagetag2,pagetag3

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

Cached pages with a tag can be deleted from the cache using the TSconfig option TCEMAIN.clearCacheCmd.

Sets the "current"-value. This is normally set from an external routine, so be careful with this. But it might come in useful.

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

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..."

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

page.10.field = title

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

You can provide multiple field name options separated by "//".

page.10.field = nav_title // title

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

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

Loads content from a content object.

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

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

Two parameters are sent to the PHP function: a content variable, which contains the current content (the value to be processed), and any sub-properties of preUserFunc.

See postUserFunc.

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

Sets the content if the content is null ( NULL type in PHP).

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

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

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

Same as ifEmpty but the check is done against '' (empty string). Zeros are not treated as blank values.

Explodes the current content (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 numeric values.

0 - last

If the content of listNum can be interpreted as an integer the corresponding index of the exploded content is returned. Counting starts at 0.

This would return "item 1":

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

This would return "item 3"

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

If set, the PHP-function trim() removes whitespace around the value.

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

Recursive call to the stdWrap function.

This flag requires the content to be set to a certain value after a content import and any processing that has occurred (data, field, current, listNum, trim). Zero is not regarded as empty. Use "if" instead.

If the content is empty, "" is returned.

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

The value in this field must be set.

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

Processing instructions to be applied to content.

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

This object allows you to parse HTML content and perform 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)

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

Calculation of the value using operators -+*/%^ while respecting the priority of + and - operators and parenthesis levels ().

. (period) is a decimal delimiter.

Returns a double value.

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. You should use proper syntax because future modifications to the function may add more operators and features.

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

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']);

PHP function intval() returns an integer:

$content = intval($content);

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.

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

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

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

The content should be the an integer representing the UNIX time (second since 1.1.1970). Returns content formatted as a date. See the PHP manual (datetime.format) for format codes.

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

Properties:

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

Render in human readable form:

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

Allows conversion of formatted dates to timestamps, for example to perform date calculations.

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

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

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

Similar to property date, but uses a different format. See the PHP manual (strftime) for format codes.

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

Properties:

.charset

Can be set to the charset of the output string if you need to convert it to UTF-8. The default is to take the charset predicted by \TYPO3\CMS\Core\Charset\CharsetConverter .

.GMT

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

This 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 for rendering than date or strftime, as it ships with default patterns for date and time based on the given locale (the examples below are 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 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

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.

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".

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".

lib.my_formatted_date = TEXT
lib.my_formatted_date {
    value = 1679022000
    formattedDate = Y-MM-dd'T'HH:mm:ssZ
}

will return the date in the ISO 8601 format: "2023-03-17T03:00:00+00:00"

If enabled with a "1" (number, integer) the content is seen as a date (UNIX-time) and the difference between current 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 upper limits of the variations are 60 minutes, 24 hours and 365 days.

If you set this property as 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:

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

Set another string if you want to change the units. You can include "-" signs. They will be removed, but they make sure that there is a space between the number and the unit.

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

Converts case

Uses "UTF-8" for the operation.

Code:

10 = TEXT
10.value = Hello world!
10.case = upper

Result:

HELLO WORLD!

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, for example, '1.53 KiB' and '1.00 MiB'. Learn about common notations in Wikipedia "Kibibyte". IEC naming with base 1024 is the default. Use subproperties 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

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 such as .labels = " Byte| Kilobyte| Megabyte| Gigabyte". Use a vertical bar to separate the labels. Enclose the whole string in double quotes.

.base = 1000

You can set custom labels to base 1000. All other values, including the default, are base 1024.

page.10 {
   value = abc
   bytes = 1
}

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

Output value 1000 without special formatting. Shows 1000:

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

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

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:

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:

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:

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:

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):

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):

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
}

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

Uses "UTF-8".

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 being used.

Strips all HTML tags.

Crops the content to a certain length.

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

numbers of characters to keep (integer): Defines the number of characters 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 symbols to be added replacing the part that was cropped. If the number of characters to keep is positive, the string will be prepended with the ellipsis, if it is negative, the string will be appended with the ellipsis.

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

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 rest of that word will be removed.

Uses "UTF-8".

Passes the content through the rawurlencode() PHP function .

Passes the content through the htmlspecialchars() PHP function.

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

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

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

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

Double line breaks are substituted with this value.

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

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

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

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

Wraps content.

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

cObject prepended the content.

cObject appended the content.

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

Wraps content with a link tag.

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

This wraps the content without trimming the values. That means that surrounding whitespace is not removed. Note that this kind of wrap needs a special character in the middle as well as the same special character at the beginning and end of the wrap (the default for all three is "|").

Additional property:

splitChar

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

page.10.noTrimWrap = | val1 | val2 |

In this example the values val1 and val2 will be wrapped, including the whitespace.

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

optionSplit will use the "||" to determine two subparts. In each subpart noTrimWrap will then use the "^" as special character.

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

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.

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

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

prepended to content (before)

appended to content (after)

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

Execute multiple stdWrap statements in an order that you choose. The order is determined by the numeric order of the keys.You can use multiple stdWrap statements without having to remember the rather complex sorting order in which the stdWrap functions are executed.

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 20 key is processed. Finally 30.wrap is executed on what already was created.

This results in "This is a working solution."

Wraps the complete content

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

Displays the page title:

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

Calls the provided PHP function. If the function name contains '->', it will be interpreted as a call to a class method.

Two parameters are sent to the PHP function: a content variable containing the current content (this is the value that will be processed) and subproperties of postUserFunc.

See description of the USER cObject for more in-depth information.

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

page = PAGE
page.typeNum = 0

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

page.20 = TEXT
page.20 {
    value = Hello World!
    stdWrap.postUserFunc = MyVendor\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.

<?php

declare(strict_types=1);

namespace MyVendor\SitePackage\UserFunctions;

use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

final class YourClass
{
    /*
     * Reference to the parent (calling) cObject set from TypoScript
     */
    private ContentObjectRenderer $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 $content holds the value to be processed.
     * @param array $conf TypoScript properties passed to this method.
     */
    public function reverseString(
        string $content,
        array $conf,
        ServerRequestInterface $request,
    ): 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 exists when postUserFunc is executed, will be processed by the function reverseString() in the class YourClass. The result will be !DLROW OLLEH.

For page.20 the result will be the same, but wrapped into a link to the page with ID 11. The result will be <a href="/path/to/page/id/11">!DLROW OLLEH</a>.

Note how in the PHP code $this->cObj, the reference to the calling cObject, uses functions from ContentObjectRenderer class.

Calls the provided PHP function. If you specify a function name with '->' it will be interpreted as a call to a class method.

Two parameters are sent to the PHP function: a content variable containing the current content (this is the value that will be processed) and subproperties of postUserFuncInt.

The result will be rendered non-cached outside the main page-rendering. See the cObject USER_INT description.

Supplied by Jens Ellerbrock

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

The content is parsed through insertData.

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

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

This property is responsible for 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 by default when invoked by stdWrap.parseFunc).
• htmlSanitize.build = [string] - defines which builder to use (must be an instance of \TYPO3\HtmlSanitizer\Builder\BuilderInterface) for building a \TYPO3\HtmlSanitizer\Sanitizer instance using a particular \TYPO3\HtmlSanitizer\Behavior. It can either be a fully qualified class name or the name of a preset as defined in $GLOBALS['TYPO3_CONF_VARS']['SYS']['htmlSanitizer'] - the default is \TYPO3\CMS\Core\Html\DefaultSanitizerBuilder .

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 the above, but specifies a builder:

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
}

Caches rendered content in the caching framework.

Prints content with HTMLSpecialChars() and <pre></pre>. Useful for debugging the resulting value of stdWrap.

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

If set to value "2" the content will be printed in a table (which looks nicer).

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