W3cubDocs

/Drupal 8

public function Renderer::renderPlain

public Renderer::renderPlain(&$elements)

Renders final HTML in situations where no assets are needed.

Calls ::render() in such a way that placeholders are replaced.

Useful for instance when rendering the values of tokens or emails, which need a render array being turned into a string, but do not need any of the bubbleable metadata (the attached assets and cache tags).

Some of these are a relatively common use case and happen *within* a ::renderRoot() call, but that is generally highly problematic (and hence an exception is thrown when a ::renderRoot() call happens within another ::renderRoot() call). However, in this case, we only care about the output, not about the bubbling. Hence this uses a separate render context, to not affect the parent ::renderRoot() call.

(Can be executed within another render context: it runs in isolation.)

Parameters

array $elements: The structured array describing the data to be rendered.

Return value

\Drupal\Component\Render\MarkupInterface The rendered HTML.

Overrides RendererInterface::renderPlain

See also

\Drupal\Core\Render\RendererInterface::renderRoot()

\Drupal\Core\Render\RendererInterface::render()

File

core/lib/Drupal/Core/Render/Renderer.php, line 149

Class

Renderer
Turns a render array into a HTML string.

Namespace

Drupal\Core\Render

Code

public function renderPlain(&$elements) {
  return $this->executeInRenderContext(new RenderContext(), function() use (&$elements) {
    return $this->render($elements, TRUE);
  });
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Render!Renderer.php/function/Renderer::renderPlain/8.1.x