class InlineTemplate

Same name and namespace in other branches

8.9.x core/lib/Drupal/Core/Render/Element/InlineTemplate.php \Drupal\Core\Render\Element\InlineTemplate
10 core/lib/Drupal/Core/Render/Element/InlineTemplate.php \Drupal\Core\Render\Element\InlineTemplate
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,
    ],
];

Plugin annotation

@RenderElement("inline_template");

Hierarchy

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

Expanded class hierarchy of InlineTemplate

39 #type uses of InlineTemplate

AddFormBase::buildForm in core/modules/media_library/src/Form/AddFormBase.php: Form constructor.
AjaxTestController::renderTypes in core/modules/system/tests/modules/ajax_test/src/Controller/AjaxTestController.php: Example content for testing the wrapper of the response.
BasicStringFormatter::viewElements in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BasicStringFormatter.php: Builds a renderable array for a field value.
BlockController::demo in core/modules/block/src/Controller/BlockController.php: Returns a block theme demo page.
BlockLibraryController::listBlocks in core/modules/block/src/Controller/BlockLibraryController.php: Shows a list of blocks that can be added to a theme's layout.

... See full list

File

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

Namespace

Drupal\Core\Render\Element

View on git.drupalcode.org

View source

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

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
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.		1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute.	Overrides ElementInterface::setAttributes

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

Breadcrumb