class Filter

Same name in this branch
  1. 8.9.x core/modules/jsonapi/src/Query/Filter.php \Drupal\jsonapi\Query\Filter
Same name and namespace in other branches
  1. 9 core/modules/jsonapi/src/Query/Filter.php \Drupal\jsonapi\Query\Filter
  2. 9 core/modules/filter/src/Annotation/Filter.php \Drupal\filter\Annotation\Filter
  3. 10 core/modules/jsonapi/src/Query/Filter.php \Drupal\jsonapi\Query\Filter
  4. 10 core/modules/filter/src/Annotation/Filter.php \Drupal\filter\Annotation\Filter
  5. 11.x core/modules/jsonapi/src/Query/Filter.php \Drupal\jsonapi\Query\Filter
  6. 11.x core/modules/filter/src/Annotation/Filter.php \Drupal\filter\Annotation\Filter
  7. 10 core/modules/filter/src/Attribute/Filter.php \Drupal\filter\Attribute\Filter
  8. 11.x core/modules/filter/src/Attribute/Filter.php \Drupal\filter\Attribute\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

162 string references to 'Filter'
AreaDisplayLinkTest::setUp in core/modules/views/tests/src/Kernel/Handler/AreaDisplayLinkTest.php
AreaTextTest::setUp in core/modules/views/tests/src/Kernel/Handler/AreaTextTest.php
BlockLibraryController::listBlocks in core/modules/block/src/Controller/BlockLibraryController.php
Shows a list of blocks that can be added to a theme's layout.
BulkFormTest::testBulkForm in core/modules/user/tests/src/Functional/Views/BulkFormTest.php
Tests the user bulk form.
ckeditor_ckeditor_css_alter in core/modules/ckeditor/ckeditor.module
Implements hook_ckeditor_css_alter().

... 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 = [];

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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 Overrides AnnotationInterface::get 5
Plugin::getClass public function Overrides AnnotationInterface::getClass
Plugin::getId public function Overrides AnnotationInterface::getId
Plugin::getProvider public function Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Overrides AnnotationInterface::setClass
Plugin::setProvider public function Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2

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