class HelpSection in Drupal 9

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.

4 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.

TestHelpSection in core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php

Provides a searchable help section for testing.

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

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 = '';

  /**
   * An optional weight for the help section.
   *
   * The sections will be ordered by this weight on the help page.
   *
   * @var int
   */
  public $weight = 0;

}

Members

Name	Modifiers	Type	Description	Overrides
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.
HelpSection::$weight	public	property	An optional weight for the help section.
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	5
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	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
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.	2