You are here

Home » API reference » Service Container 7.2 » SafeMarkup.php » SafeMarkup

public static function SafeMarkup::checkPlain in Service Container 7.2

Same name and namespace in other branches
  1. 7 lib/Drupal/Component/Utility/SafeMarkup.php \Drupal\Component\Utility\SafeMarkup::checkPlain()

Encodes special characters in a plain-text string for display as HTML.

Also validates strings as UTF-8. All processed strings are also automatically flagged as safe markup strings for rendering.

Parameters

string $text: The text to be checked or processed.

Return value

\Drupal\Component\Render\HtmlEscapedText An HtmlEscapedText object that escapes when rendered to string.

Deprecated

Will be removed before Drupal 9.0.0. Rely on Twig's auto-escaping feature, or use the #plain_text key when constructing a render array that contains plain text in order to use the renderer's auto-escaping feature. If neither of these are possible, \Drupal\Component\Utility\Html::escape() can be used in places where explicit escaping is needed.

See also

drupal_validate_utf8()

File

lib/Drupal/Component/Utility/SafeMarkup.php, line 68
Contains \Drupal\Component\Utility\SafeMarkup.

Class

SafeMarkup
Contains deprecated functionality related to sanitization of markup.

Namespace

Drupal\Component\Utility

Code

public static function checkPlain($text) {
  return new HtmlEscapedText($text);
}