Defines a Plugin annotation object for help page section plugins.
Plugin Namespace: Plugin\HelpSection
For a working example, see \Drupal\help\Plugin\HelpSection\HookHelpSection.
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\help\Annotation\HelpSection
See also
\Drupal\help\HelpSectionPluginInterface
\Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
\Drupal\help\HelpSectionManager
hook_help_section_info_alter()
Plugin API
Related topics
- Annotations
- Annotations for class discovery and metadata description.
File
- core/modules/help/src/Annotation/HelpSection.php, line 22
Namespace
Drupal\help\Annotation
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| HelpSection::$description | public | property | The description of the help page section. |
| HelpSection::$id | public | property | The plugin ID. |
| HelpSection::$permission | public | property | The (optional) permission needed to view the help section. |
| HelpSection::$title | public | property | The text to use as the title of the help page section. |
| 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.