class 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,
    ],
];

Plugin annotation

@RenderElement("inline_template");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
      • class \Drupal\Core\Render\Element\InlineTemplate extends \Drupal\Core\Render\Element\RenderElement

Expanded class hierarchy of InlineTemplate

File

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

Namespace

class InlineTemplate extends RenderElement {
    
    /**
     * {@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