class HelpSectionPluginBase

Same name and namespace in other branches
  1. 11.x core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
  2. 10 core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
  3. 8.9.x core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase

Provides a base class for help section plugins.

Hierarchy

Expanded class hierarchy of HelpSectionPluginBase

See also

\Drupal\help\HelpSectionPluginInterface

\Drupal\help\Annotation\HelpSection

\Drupal\help\HelpSectionManager

4 files declare their use of HelpSectionPluginBase
EmptyHelpSection.php in core/modules/help/tests/modules/help_page_test/src/Plugin/HelpSection/EmptyHelpSection.php
HelpTopicSection.php in core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php
TestHelpSection.php in core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
TourHelpSection.php in core/modules/tour/src/Plugin/HelpSection/TourHelpSection.php

File

core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php, line 16

Namespace

Drupal\help\Plugin\HelpSection
View source
abstract class HelpSectionPluginBase extends PluginBase implements HelpSectionPluginInterface {
  use UnchangingCacheableDependencyTrait;
  
  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return $this->getPluginDefinition()['title'];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->getPluginDefinition()['description'];
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.