1. class
  2. Drupal
  3. \
  4. Component
  5. \
  6. Render
  7. \
  8. PlainTextOutput

PlainTextOutput

class PlainTextOutput implements OutputStrategyInterface (View source)

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.

Methods

static string
renderFromHtml(string|object $string)

Transforms a given HTML string into to a context-appropriate output string.

Details

at line 21
static string renderFromHtml(string|object $string)

Transforms a given HTML string into to a context-appropriate output string.

This transformation consists of performing the formatting appropriate to a given output context (e.g., plain-text email subjects, HTML attribute values).

Parameters

string|object $string

An HTML string or an object with a ::__toString() magic method returning HTML markup. The source HTML markup is considered ready for output into HTML fragments and thus already properly escaped and sanitized.

Return Value

string

A new string that is formatted according to the output strategy.