1. 8.3.x core/modules/filter/src/Annotation/Filter.php Filter
  2. 8.0.x core/modules/filter/src/Annotation/Filter.php Filter
  3. 8.1.x core/modules/filter/src/Annotation/Filter.php Filter
  4. 8.2.x core/modules/filter/src/Annotation/Filter.php Filter
  5. 8.4.x core/modules/filter/src/Annotation/Filter.php Filter

Defines an filter annotation object.

Plugin Namespace: Plugin\Filter

For a working example, see \Drupal\filter\Plugin\Filter\FilterHtml

Hierarchy

Expanded class hierarchy of Filter

See also

\Drupal\filter\FilterPluginManager

\Drupal\filter\Plugin\FilterInterface

\Drupal\filter\Plugin\FilterBase

Plugin API

Related topics

43 string references to 'Filter'
BlockLibraryController::listBlocks in core/modules/block/src/Controller/BlockLibraryController.php
Shows a list of blocks that can be added to a theme's layout.
ConfigTranslationUiTest::testSiteInformationTranslationUi in core/modules/config_translation/src/Tests/ConfigTranslationUiTest.php
Tests the site information translation interface.
core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml
core/config/schema/core.data_types.schema.yml
DblogFilterForm::buildForm in core/modules/dblog/src/Form/DblogFilterForm.php
Form constructor.
DbLogTest::filterLogsEntries in core/modules/dblog/src/Tests/DbLogTest.php
Filters the logs according to the specific severity and log entry type.

... See full list

20 classes are annotated with Filter
EditorFileReference in core/modules/editor/src/Plugin/Filter/EditorFileReference.php
Provides a filter to track images uploaded via a Text Editor.
FilterAlign in core/modules/filter/src/Plugin/Filter/FilterAlign.php
Provides a filter to align elements.
FilterAutoP in core/modules/filter/src/Plugin/Filter/FilterAutoP.php
Provides a filter to convert line breaks to HTML.
FilterCaption in core/modules/filter/src/Plugin/Filter/FilterCaption.php
Provides a filter to caption elements.
FilterHtml in core/modules/filter/src/Plugin/Filter/FilterHtml.php
Provides a filter to limit allowed HTML tags.

... See full list

File

core/modules/filter/src/Annotation/Filter.php, line 21

Namespace

Drupal\filter\Annotation
View source
class Filter extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The name of the provider that owns the filter.
   *
   * @var string
   */
  public $provider;

  /**
   * The human-readable name of the filter.
   *
   * This is used as an administrative summary of what the filter does.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $title;

  /**
   * Additional administrative information about the filter's behavior.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   */
  public $description = '';

  /**
   * A default weight for the filter in new text formats.
   *
   * @var int (optional)
   */
  public $weight = 0;

  /**
   * Whether this filter is enabled or disabled by default.
   *
   * @var bool (optional)
   */
  public $status = FALSE;

  /**
   * The default settings for the filter.
   *
   * @var array (optional)
   */
  public $settings = array();

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
Filter::$description public property Additional administrative information about the filter's behavior.
Filter::$id public property The plugin ID.
Filter::$provider public property The name of the provider that owns the filter.
Filter::$settings public property The default settings for the filter.
Filter::$status public property Whether this filter is enabled or disabled by default.
Filter::$title public property The human-readable name of the filter.
Filter::$weight public property A default weight for the filter in new text formats.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 2
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2