Render ViewHelper <f:render>

A ViewHelper to render a section, a partial, a specified section in a partial or a delegate ParsedTemplateInterface implementation.

Examples

Rendering partials

<f:render partial="SomePartial" arguments="{foo: someVariable}" />
Copied!

Output:

the content of the partial "SomePartial". The content of the variable {someVariable} will be available in the partial as {foo}
Copied!

Rendering sections

<f:section name="someSection">This is a section. {foo}</f:section>
<f:render section="someSection" arguments="{foo: someVariable}" />
Copied!

Output:

the content of the section "someSection". The content of the variable {someVariable} will be available in the partial as {foo}
Copied!

Rendering recursive sections

<f:section name="mySection">
    <ul>
        <f:for each="{myMenu}" as="menuItem">
            <li>
                {menuItem.text}
                <f:if condition="{menuItem.subItems}">
                    <f:render section="mySection" arguments="{myMenu: menuItem.subItems}" />
                </f:if>
            </li>
        </f:for>
    </ul>
   </f:section>
   <f:render section="mySection" arguments="{myMenu: menu}" />
Copied!

Output:

<ul>
    <li>menu1
        <ul>
          <li>menu1a</li>
          <li>menu1b</li>
        </ul>
    </li>
[...]
(depending on the value of {menu})

Copied!

Passing all variables to a partial

<f:render partial="somePartial" arguments="{_all}" />
Copied!

Output:

the content of the partial "somePartial".
Using the reserved keyword "_all", all available variables will be passed along to the partial

Copied!

Rendering via a delegate ParsedTemplateInterface implementation w/ custom arguments

<f:render delegate="My\Special\ParsedTemplateImplementation" arguments="{_all}" />
Copied!

This will output whichever output was generated by calling My\Special\ParsedTemplateImplementation->render() with cloned RenderingContextInterface $renderingContext as only argument and content of arguments assigned in VariableProvider of cloned context. Supports all other input arguments including recursive rendering, contentAs argument, default value etc.

Note that while ParsedTemplateInterface supports returning a Layout name, this Layout will not be respected when rendering using this method. Only the render() method will be called!

Source code

Go to the source code of this ViewHelper: RenderViewHelper.php (GitHub).

Arguments

The following arguments are available for <f:render>:

Name display Type Default
string
string
string
mixed
mixed array ()
boolean
mixed
string
section
Type
string

Section to render - combine with partial to render section in partial

partial
Type
string

Partial to render, with or without section

delegate
Type
string

Optional PHP class name of a permanent, included-in-app ParsedTemplateInterface implementation to override partial/section

renderable
Type
mixed

Instance of a RenderableInterface implementation to be rendered

arguments
Type
mixed
Default
array ()

Array of variables to be transferred. Use {_all} for all variables

optional
Type
boolean

If TRUE, considers the section optional. Partial never is.

default
Type
mixed

Value (usually string) to be displayed if the section or partial does not exist

contentAs
Type
string

If used, renders the child content and adds it as a template variable with this name for use in the partial/section