class FilterHtmlEscape

Same name in other branches
  1. 9 core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php \Drupal\filter\Plugin\Filter\FilterHtmlEscape
  2. 8.9.x core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php \Drupal\filter\Plugin\Filter\FilterHtmlEscape
  3. 10 core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php \Drupal\filter\Plugin\Filter\FilterHtmlEscape

Provides a filter to display any HTML as plain text.

Hierarchy

Expanded class hierarchy of FilterHtmlEscape

File

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

Namespace

Drupal\filter\Plugin\Filter
View source 
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

Title Modifiers Object type Summary Overriden Title Overrides
FilterBase::$provider public property The name of the provider that owns this filter.
FilterBase::$settings public property An associative array containing the configured settings of this filter.
FilterBase::$status public property A Boolean indicating whether this filter is enabled.
FilterBase::$weight public property The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies public function Overrides DependentPluginInterface::calculateDependencies 1
FilterBase::defaultConfiguration public function Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration public function Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription public function Overrides FilterInterface::getDescription
FilterBase::getLabel public function Overrides FilterInterface::getLabel
FilterBase::getType public function Overrides FilterInterface::getType
FilterBase::prepare public function Overrides FilterInterface::prepare
FilterBase::setConfiguration public function Overrides ConfigurableInterface::setConfiguration 1
FilterBase::settingsForm public function Overrides FilterInterface::settingsForm 3
FilterBase::__construct public function 4
FilterHtmlEscape::getHTMLRestrictions public function Overrides FilterBase::getHTMLRestrictions
FilterHtmlEscape::process public function Overrides FilterInterface::process
FilterHtmlEscape::tips public function Overrides FilterBase::tips
FilterInterface::TYPE_HTML_RESTRICTOR constant HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE constant Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE constant Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE constant Reversible transformation filters.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 7
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 3

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