By claudiu.cristea on
Change record status: 
Published (View all published change records)
Project: 
Drupal core
Introduced in branch: 
11.4.x
Introduced in version: 
11.4.0
Issue links: 
https://www.drupal.org/node/455724
Description: 

The check_markup() function is deprecated and no replacement is provided. It's always recommended to return a renderable array, when possible, without flattening as markup, to preserve the cacheability metadata.

Before

$formatted_text = check_markup($text, 'basic_html', $langcode, $filter_types_to_skip);

After

$formatted_text = [
  '#type' => 'processed_text',
  '#text' => $text,
  '#format' => 'basic_html',
  '#filter_types_to_skip' => $filter_types_to_skip,
  '#langcode' => $langcode,
];

Particular cases:

  • Mail: A common use case where check_markup() is still frequently used is hook_mail() as that does not support render arrays. Future Drupal mail system development will pipe the mail preparation through Twig (for both, plain and HTML messages). This will remove the need to manually render the renderable array (see #3539651: Introduce email plugins). Until that API is available, \Drupal::service('renderer')->renderInIsolation($build) may be used. Refer to the documentation on \Drupal\Core\Render\RendererInterface when render() vs renderInIsolation() should be used.
  • Tests: Many tests are only asserting that a text has been formatted correctly. For convenience, Drupal provides the \Drupal\Tests\filter\Traits\ProcessedTextTestTrait trait with a helper method, facilitating testing.
Impacts: 
Module developers
Themers