From 9bd83496688b34221a9ba13204438ceb1b6612c9 Mon Sep 17 00:00:00 2001 From: FluidTYPO3 VHS Date: Wed, 6 Sep 2023 11:58:52 +0000 Subject: [PATCH] [TASK] Regenerate ViewHelper documentation --- Documentation/ViewHelpers/Format/Replace.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/Documentation/ViewHelpers/Format/Replace.rst b/Documentation/ViewHelpers/Format/Replace.rst index 4ba2c0c89..b2095891b 100644 --- a/Documentation/ViewHelpers/Format/Replace.rst +++ b/Documentation/ViewHelpers/Format/Replace.rst @@ -9,6 +9,17 @@ format.replace Replaces $substring in $content with $replacement. +Supports array as input substring/replacements and content. + +When input substring/replacement is an array, both must be +the same length and must contain only strings. + +When input content is an array, the search/replace is done +on every value in the input content array and the return +value will be an array of equal size as the input content +array but with all values search/replaced. All values in the +input content array must be strings. + Arguments ========= @@ -24,7 +35,7 @@ content :aspect:`Required` false :aspect:`Description` - Content in which to perform replacement + Content in which to perform replacement. Array supported. .. _format.replace_substring: @@ -37,7 +48,7 @@ substring :aspect:`Required` true :aspect:`Description` - Substring to replace + Substring to replace. Array supported. .. _format.replace_replacement: @@ -50,7 +61,7 @@ replacement :aspect:`Required` false :aspect:`Description` - Replacement to insert + Replacement to insert. Array supported. .. _format.replace_returncount: