class InlineTemplate

Same name in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/InlineTemplate.php \Drupal\Core\Render\Element\InlineTemplate
  2. 8.9.x core/lib/Drupal/Core/Render/Element/InlineTemplate.php \Drupal\Core\Render\Element\InlineTemplate
  3. 11.x core/lib/Drupal/Core/Render/Element/InlineTemplate.php \Drupal\Core\Render\Element\InlineTemplate

Provides a render element where the user supplies an in-line Twig template.

Properties:

  • #template: The inline Twig template used to render the element.
  • #context: (array) The variables to substitute into the Twig template. Each variable may be a string or a render array.

Usage example:

$build['hello'] = [
    '#type' => 'inline_template',
    '#template' => "{% trans %} Hello {% endtrans %} <strong>{{name}}</strong>",
    '#context' => [
        'name' => $name,
    ],
];

Hierarchy

Expanded class hierarchy of InlineTemplate

File

core/lib/Drupal/Core/Render/Element/InlineTemplate.php, line 26

Namespace

Drupal\Core\Render\Element
View source
class InlineTemplate extends RenderElementBase {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = static::class;
        return [
            '#pre_render' => [
                [
                    $class,
                    'preRenderInlineTemplate',
                ],
            ],
            '#template' => '',
            '#context' => [],
        ];
    }
    
    /**
     * Renders a twig string directly.
     *
     * @param array $element
     *   The element.
     *
     * @return array
     */
    public static function preRenderInlineTemplate($element) {
        
        /** @var \Drupal\Core\Template\TwigEnvironment $environment */
        $environment = \Drupal::service('twig');
        $markup = $environment->renderInline($element['#template'], $element['#context']);
        $element['#markup'] = $markup;
        return $element;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
InlineTemplate::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
InlineTemplate::preRenderInlineTemplate public static function Renders a twig string directly.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
RenderElementBase::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. 2
RenderElementBase::preRenderGroup public static function Adds members of this group as actual elements for rendering. 2
RenderElementBase::processAjaxForm public static function Form element processing handler for the #ajax form property. 3
RenderElementBase::processGroup public static function Arranges elements into groups. 2
RenderElementBase::setAttributes public static function Sets a form element&#039;s class attribute. Overrides ElementInterface::setAttributes 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.