FilterHtmlEscape.php

Same filename in other branches
  1. 8.9.x core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php
  2. 10 core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php
  3. 11.x core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php

Namespace

Drupal\filter\Plugin\Filter

File

core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php

View source
<?php

namespace Drupal\filter\Plugin\Filter;

use Drupal\filter\FilterProcessResult;
use Drupal\filter\Plugin\FilterBase;

/**
 * Provides a filter to display any HTML as plain text.
 *
 * @Filter(
 *   id = "filter_html_escape",
 *   title = @Translation("Display any HTML as plain text"),
 *   type = Drupal\filter\Plugin\FilterInterface::TYPE_HTML_RESTRICTOR,
 *   weight = -10
 * )
 */
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.');
    }

}

Classes

Title Deprecated Summary
FilterHtmlEscape Provides a filter to display any HTML as plain text.

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