Same name and namespace in other branches
  1. 8.9.x core/modules/filter/src/Annotation/Filter.php \Drupal\filter\Annotation\Filter
  2. 9 core/modules/filter/src/Annotation/Filter.php \Drupal\filter\Annotation\Filter

Defines a 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

67 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.
BulkOperationsTest::testBulkOperations in core/modules/views/tests/src/FunctionalJavascript/Plugin/BulkOperationsTest.php
claro_form_system_modules_alter in core/themes/claro/claro.theme
Implements hook_form_FORM_ID_alter() for the system_modules form.
claro_form_user_admin_permissions_alter in core/themes/claro/claro.theme
Implements hook_form_FORM_ID_alter() for the user_admin_permissions form.
ConfigTranslationUiSiteInformationTest::testSiteInformationTranslationUi in core/modules/config_translation/tests/src/Functional/ConfigTranslationUiSiteInformationTest.php
Tests the site information translation interface.

... 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.
   *
   * This property is optional and it does not need to be declared.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description = '';

  /**
   * A default weight for the filter in new text formats.
   *
   * This property is optional and it does not need to be declared.
   *
   * @var int
   */
  public $weight = 0;

  /**
   * Whether this filter is enabled or disabled by default.
   *
   * This property is optional and it does not need to be declared.
   *
   * @var bool
   */
  public $status = FALSE;

  /**
   * The default settings for the filter.
   *
   * This property is optional and it does not need to be declared.
   *
   * @var array
   */
  public $settings = [];

}

Members

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 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
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 1
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. 3