1. 8.2.x core/modules/help/src/Annotation/HelpSection.php HelpSection
  2. 8.1.x core/modules/help/src/Annotation/HelpSection.php HelpSection
  3. 8.3.x core/modules/help/src/Annotation/HelpSection.php HelpSection

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

Expanded class hierarchy of HelpSection

See also

\Drupal\help\HelpSectionPluginInterface

\Drupal\help\Plugin\HelpSection\HelpSectionPluginBase

\Drupal\help\HelpSectionManager

hook_help_section_info_alter()

Plugin API

Related topics

3 classes are annotated with HelpSection
EmptyHelpSection in core/modules/help/tests/modules/help_page_test/src/Plugin/HelpSection/EmptyHelpSection.php
Provides an empty section for the help page, for testing.
HookHelpSection in core/modules/help/src/Plugin/HelpSection/HookHelpSection.php
Provides the module topics list section for the help page.
TourHelpSection in core/modules/tour/src/Plugin/HelpSection/TourHelpSection.php
Provides the tours list section for the help page.

File

core/modules/help/src/Annotation/HelpSection.php, line 22

Namespace

Drupal\help\Annotation
View source
class HelpSection extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The text to use as the title of the help page section.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * The description of the help page section.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The (optional) permission needed to view the help section.
   *
   * Only set if this section needs its own permission, beyond the generic
   * 'access administration pages' permission needed to see the /admin/help
   * page itself.
   *
   * @var string
   */
  public $permission = '';

}

Members

Contains filters are case sensitive
Namesort descending 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.