class FilterHtmlEscape

Provides a filter to display any HTML as plain text.

Plugin annotation

@Filter(
  id = "filter_html_escape",
  title = @Translation("Display any HTML as plain text"),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_HTML_RESTRICTOR,
  weight = -10
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\filter\Plugin\FilterBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\filter\Plugin\FilterInterface
      • class \Drupal\filter\Plugin\Filter\FilterHtmlEscape extends \Drupal\filter\Plugin\FilterBase

Expanded class hierarchy of FilterHtmlEscape

File

core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php, line 18

Namespace

class FilterHtmlEscape extends FilterBase {
    
    /**
     * {@inheritdoc}
     */
    public function process($text, $langcode) {
        return new FilterProcessResult(_filter_html_escape($text));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getHTMLRestrictions() {
        // Nothing is allowed.
        return [
            'allowed' => [],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function tips($long = FALSE) {
        return $this->t('No HTML tags allowed.');
    }

}

Members