class FilterAutoP

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

Provides a filter to convert line breaks to HTML.

Plugin annotation


@Filter(
  id = "filter_autop",
  title = @Translation("Convert line breaks into HTML (i.e. <code>&lt;br&gt;</code> and <code>&lt;p&gt;</code>)"),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_MARKUP_LANGUAGE
)

Hierarchy

Expanded class hierarchy of FilterAutoP

1 file declares its use of FilterAutoP
FundamentalCompatibilityConstraintValidator.php in core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraintValidator.php

File

core/modules/filter/src/Plugin/Filter/FilterAutoP.php, line 17

Namespace

Drupal\filter\Plugin\Filter
View source
class FilterAutoP extends FilterBase {
    
    /**
     * {@inheritdoc}
     */
    public function process($text, $langcode) {
        return new FilterProcessResult(_filter_autop($text));
    }
    
    /**
     * {@inheritdoc}
     */
    public function tips($long = FALSE) {
        if ($long) {
            return $this->t('Lines and paragraphs are automatically recognized. The &lt;br /&gt; line break, &lt;p&gt; paragraph and &lt;/p&gt; close paragraph tags are inserted automatically. If paragraphs are not recognized simply add a couple of blank lines.');
        }
        else {
            return $this->t('Lines and paragraphs break automatically.');
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
FilterAutoP::process public function Performs the filter processing. Overrides FilterInterface::process
FilterAutoP::tips public function Generates a filter&#039;s tip. Overrides FilterBase::tips
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&#039;s configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription public function Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions public function Returns HTML allowed by this filter&#039;s configuration. Overrides FilterInterface::getHTMLRestrictions 4
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&#039;s settings form. Overrides FilterInterface::settingsForm 3
FilterBase::__construct public function 4
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. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

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