Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. HelpSectionPluginBase.php

class HelpSectionPluginBase

Provides a base class for help section plugins.

Hierarchy

  • class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
    • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
      • class \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\help\HelpSectionPluginInterface uses \Drupal\Core\Cache\UnchangingCacheableDependencyTrait

Expanded class hierarchy of HelpSectionPluginBase

See also

\Drupal\help\HelpSectionPluginInterface

\Drupal\help\Annotation\HelpSection

\Drupal\help\HelpSectionManager

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'];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
HelpSectionPluginBase::getDescription public function Returns the description text for the help section. Overrides HelpSectionPluginInterface::getDescription
HelpSectionPluginBase::getTitle public function Returns the title of the help section. Overrides HelpSectionPluginInterface::getTitle
HelpSectionPluginInterface::listTopics public function Returns a list of topics to show in the help section. 2
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 5
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
UnchangingCacheableDependencyTrait::getCacheContexts public function 1
UnchangingCacheableDependencyTrait::getCacheMaxAge public function 2
UnchangingCacheableDependencyTrait::getCacheTags public function 1

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal