Defines an filter annotation object.
Plugin Namespace: Plugin\Filter
For a working example, see \Drupal\filter\Plugin\Filter\FilterHtml
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\filter\Annotation\Filter
See also
\Drupal\filter\FilterPluginManager
\Drupal\filter\Plugin\FilterInterface
\Drupal\filter\Plugin\FilterBase
Plugin API
Related topics
- Annotations
- Annotations for class discovery and metadata description.
File
- core/modules/filter/src/Annotation/Filter.php, line 21
Namespace
Drupal\filter\Annotation
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| 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. |
| Plugin::get | public | function | Gets the value of an annotation. Overrides AnnotationInterface::get |
| 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 |
| 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. |
Please login to continue.