class PlainTextOutput

Same name in other branches
  1. 8.9.x core/lib/Drupal/Component/Render/PlainTextOutput.php \Drupal\Component\Render\PlainTextOutput
  2. 10 core/lib/Drupal/Component/Render/PlainTextOutput.php \Drupal\Component\Render\PlainTextOutput
  3. 11.x core/lib/Drupal/Component/Render/PlainTextOutput.php \Drupal\Component\Render\PlainTextOutput

Provides an output strategy for transforming HTML into simple plain text.

Use this when rendering a given HTML string into a plain text string that does not need special formatting, such as a label or an email subject.

Returns a string with HTML tags stripped and HTML entities decoded suitable for email or other non-HTML contexts.

Hierarchy

Expanded class hierarchy of PlainTextOutput

17 files declare their use of PlainTextOutput
Attribute.php in core/lib/Drupal/Core/Template/Attribute.php
EmailAction.php in core/lib/Drupal/Core/Action/Plugin/Action/EmailAction.php
EntityResourceValidationTrait.php in core/modules/rest/src/Plugin/rest/resource/EntityResourceValidationTrait.php
FileItem.php in core/modules/file/src/Plugin/Field/FieldType/FileItem.php
FileUpload.php in core/modules/jsonapi/src/Controller/FileUpload.php

... See full list

File

core/lib/Drupal/Component/Render/PlainTextOutput.php, line 16

Namespace

Drupal\Component\Render
View source
class PlainTextOutput implements OutputStrategyInterface {
    
    /**
     * {@inheritdoc}
     */
    public static function renderFromHtml($string) {
        return Html::decodeEntities(strip_tags((string) $string));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
PlainTextOutput::renderFromHtml public static function Transforms a given HTML string into to a context-appropriate output string. Overrides OutputStrategyInterface::renderFromHtml

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.