W3cubDocs

/Drupal 8

public static function SafeMarkup::checkPlain

public static SafeMarkup::checkPlain($text)

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

core/lib/Drupal/Component/Utility/SafeMarkup.php, line 63

Class

SafeMarkup
Contains deprecated functionality related to sanitization of markup.

Namespace

Drupal\Component\Utility

Code

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

© 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!Component!Utility!SafeMarkup.php/function/SafeMarkup::checkPlain/8.1.x