class FilterHtmlEscape
Same name and namespace in other branches
- 9 core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php \Drupal\filter\Plugin\Filter\FilterHtmlEscape
- 8.9.x core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php \Drupal\filter\Plugin\Filter\FilterHtmlEscape
- 10 core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php \Drupal\filter\Plugin\Filter\FilterHtmlEscape
Provides a filter to display any HTML as plain text.
Attributes
#[Filter(id: "filter_html_escape", title: new TranslatableMarkup("Display any HTML as plain text"), type: FilterInterface::TYPE_HTML_RESTRICTOR, weight: -10)]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\filter\Plugin\FilterBase extends \Drupal\filter\Plugin\FilterInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\filter\Plugin\Filter\FilterHtmlEscape implements \Drupal\filter\Plugin\FilterBase
- class \Drupal\filter\Plugin\FilterBase extends \Drupal\filter\Plugin\FilterInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of FilterHtmlEscape
File
-
core/
modules/ filter/ src/ Plugin/ Filter/ FilterHtmlEscape.php, line 14
Namespace
Drupal\filter\Plugin\FilterView 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 Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | 3 | |||
DependencySerializationTrait::__wakeup | public | function | 3 | |||
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 | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 1 | |
FilterBase::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides ConfigurableInterface::defaultConfiguration | ||
FilterBase::getConfiguration | public | function | Gets this plugin's configuration. | Overrides ConfigurableInterface::getConfiguration | ||
FilterBase::getDescription | public | function | Returns the administrative description for this filter plugin. | Overrides FilterInterface::getDescription | ||
FilterBase::getLabel | public | function | Returns the administrative label for this filter plugin. | Overrides FilterInterface::getLabel | ||
FilterBase::getType | public | function | Returns the processing type of this filter plugin. | Overrides FilterInterface::getType | ||
FilterBase::prepare | public | function | Prepares the text for processing. | Overrides FilterInterface::prepare | ||
FilterBase::setConfiguration | public | function | Sets the configuration for this plugin instance. | Overrides ConfigurableInterface::setConfiguration | 1 | |
FilterBase::settingsForm | public | function | Generates a filter's settings form. | Overrides FilterInterface::settingsForm | 3 | |
FilterBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides PluginBase::__construct | 4 | |
FilterHtmlEscape::getHTMLRestrictions | public | function | Returns HTML allowed by this filter's configuration. | Overrides FilterBase::getHTMLRestrictions | ||
FilterHtmlEscape::process | public | function | Performs the filter processing. | Overrides FilterInterface::process | ||
FilterHtmlEscape::tips | public | function | Generates a filter's tip. | 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. | ||||
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
PluginBase::$pluginId | protected | property | The plugin ID. | |||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.