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

Namespace

Drupal\help\Annotation

File

core/modules/help/src/Annotation/HelpSection.php
View source
  1. <?php
  2. namespace Drupal\help\Annotation;
  3. use Drupal\Component\Annotation\Plugin;
  4. /**
  5. * Defines a Plugin annotation object for help page section plugins.
  6. *
  7. * Plugin Namespace: Plugin\HelpSection
  8. *
  9. * For a working example, see \Drupal\help\Plugin\HelpSection\HookHelpSection.
  10. *
  11. * @see \Drupal\help\HelpSectionPluginInterface
  12. * @see \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
  13. * @see \Drupal\help\HelpSectionManager
  14. * @see hook_help_section_info_alter()
  15. * @see plugin_api
  16. *
  17. * @Annotation
  18. */
  19. class HelpSection extends Plugin {
  20. /**
  21. * The plugin ID.
  22. *
  23. * @var string
  24. */
  25. public $id;
  26. /**
  27. * The text to use as the title of the help page section.
  28. *
  29. * @var \Drupal\Core\Annotation\Translation
  30. *
  31. * @ingroup plugin_translatable
  32. */
  33. public $title;
  34. /**
  35. * The description of the help page section.
  36. *
  37. * @var \Drupal\Core\Annotation\Translation
  38. *
  39. * @ingroup plugin_translatable
  40. */
  41. public $description;
  42. /**
  43. * The (optional) permission needed to view the help section.
  44. *
  45. * Only set if this section needs its own permission, beyond the generic
  46. * 'access administration pages' permission needed to see the /admin/help
  47. * page itself.
  48. *
  49. * @var string
  50. */
  51. public $permission = '';
  52. }

Classes

Namesort descending Description
HelpSection Defines a Plugin annotation object for help page section plugins.