function HelpSectionPluginInterface::getDescription

Same name in other branches
  1. 9 core/modules/help/src/HelpSectionPluginInterface.php \Drupal\help\HelpSectionPluginInterface::getDescription()
  2. 10 core/modules/help/src/HelpSectionPluginInterface.php \Drupal\help\HelpSectionPluginInterface::getDescription()
  3. 11.x core/modules/help/src/HelpSectionPluginInterface.php \Drupal\help\HelpSectionPluginInterface::getDescription()

Returns the description text for the help section.

Return value

string The description text, which could be a plain string or an object that can be cast to a string.

1 method overrides HelpSectionPluginInterface::getDescription()
HelpSectionPluginBase::getDescription in core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php
Returns the description text for the help section.

File

core/modules/help/src/HelpSectionPluginInterface.php, line 36

Class

HelpSectionPluginInterface
Provides an interface for a plugin for a section of the /admin/help page.

Namespace

Drupal\help

Code

public function getDescription();

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