class Filter

Same name in this branch
  1. 10 core/modules/jsonapi/src/Query/Filter.php \Drupal\jsonapi\Query\Filter
  2. 10 core/modules/filter/src/Annotation/Filter.php \Drupal\filter\Annotation\Filter
Same name 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. 8.9.x core/modules/jsonapi/src/Query/Filter.php \Drupal\jsonapi\Query\Filter
  4. 8.9.x 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. 11.x core/modules/filter/src/Attribute/Filter.php \Drupal\filter\Attribute\Filter

Defines a filter attribute for plugin discovery.

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

23 files declare their use of Filter
EditorFileReference.php in core/modules/editor/src/Plugin/Filter/EditorFileReference.php
FilterAlign.php in core/modules/filter/src/Plugin/Filter/FilterAlign.php
FilterAutoP.php in core/modules/filter/src/Plugin/Filter/FilterAutoP.php
FilterCaption.php in core/modules/filter/src/Plugin/Filter/FilterCaption.php
FilterHtml.php in core/modules/filter/src/Plugin/Filter/FilterHtml.php

... See full list

206 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
AreaTextTokenTest::setUp in core/modules/views/tests/src/Kernel/Handler/AreaTextTokenTest.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.

... See full list

File

core/modules/filter/src/Attribute/Filter.php, line 22

Namespace

Drupal\filter\Attribute
View source
class Filter extends Plugin {
    
    /**
     * Constructs a Filter attribute.
     *
     * @param string $id
     *   The plugin ID.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup $title
     *   The human-readable name of the filter. This is used as an administrative
     *   summary of what the filter does.
     * @param int $type
     *   The filter type. Values are defined in
     *   \Drupal\filter\Plugin\FilterInterface.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
     *   (optional) Additional administrative information about the filter's
     *   behavior.
     * @param int $weight
     *   (optional) A default weight for the filter in new text formats.
     * @param bool $status
     *   (optional) Whether this filter is enabled or disabled by default.
     * @param array $settings
     *   (optional) The default settings for the filter.
     */
    public function __construct(string $id, TranslatableMarkup $title, int $type, ?TranslatableMarkup $description = NULL, int $weight = 0, bool $status = FALSE, array $settings = []) {
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AttributeBase::$class protected property The class used for this attribute class.
AttributeBase::$provider protected property The provider of the attribute class.
AttributeBase::get public function Overrides AttributeInterface::get 6
AttributeBase::getClass public function Overrides AttributeInterface::getClass 1
AttributeBase::getId public function Overrides AttributeInterface::getId
AttributeBase::getProvider public function Overrides AttributeInterface::getProvider
AttributeBase::setClass public function Overrides AttributeInterface::setClass 1
AttributeBase::setProvider public function Overrides AttributeInterface::setProvider
Filter::__construct public function Constructs a Filter attribute. Overrides Plugin::__construct

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