RendererInterface::renderPlain() is deprecated in favour of ::renderInIsolation()

By dimitriskr on 4 March 2024

Change record status:

Published (View all published change records)

Project:

Drupal core

Introduced in branch:

10.3.x

Introduced in version:

10.3.0

Issue links:

https://www.drupal.org/node/2511308

Description:

\Drupal\Core\Render\RendererInterface::renderPlain() is deprecated. Use \Drupal\Core\Render\RendererInterface::renderInIsolation() instead.

Before

\Drupal::service('renderer')->renderPlain($elements);

After

\Drupal::service('renderer')->renderInIsolation($elements);

Via the DeprecationHelper

@see DeprecationHelper helps modules support multiple versions of core

/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$output = DeprecationHelper::backwardsCompatibleCall(
  currentVersion: \Drupal::VERSION,
  deprecatedVersion: '10.3',
  currentCallable: fn() => $renderer->renderInIsolation($elements),
  deprecatedCallable: fn() => $renderer->renderPlain($elements),
);

Impacts:

Module developers

Comments

Using the DeprecationHelper to maintain backward compatibility

jrockowitz commented 7 April 2024 at 12:38

Below is how to use the DeprecationHelper to maintain backward compatibility.

/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$output = DeprecationHelper::backwardsCompatibleCall(
  currentVersion: \Drupal::VERSION,
  deprecatedVersion: '10.3',
  currentCallable: fn() => $renderer->renderInIsolation($elements),
  deprecatedCallable: fn() => $renderer->renderPlain($elements,
);

/** @var \Drupal\Core\Render

ankitv18 commented 20 May 2024 at 08:01

Use below code block for backward compatibility as suggested above has missing closing bracket.

/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$output = DeprecationHelper::backwardsCompatibleCall(
  currentVersion: \Drupal::VERSION,
  deprecatedVersion: '10.3',
  currentCallable: fn() => $renderer->renderInIsolation($elements),
  deprecatedCallable: fn() => $renderer->renderPlain($elements),
);