function HelpTopicPluginInterface::isTopLevel

Same name in other branches
  1. 8.9.x core/modules/help_topics/src/HelpTopicPluginInterface.php \Drupal\help_topics\HelpTopicPluginInterface::isTopLevel()
  2. 10 core/modules/help/src/HelpTopicPluginInterface.php \Drupal\help\HelpTopicPluginInterface::isTopLevel()
  3. 11.x core/modules/help/src/HelpTopicPluginInterface.php \Drupal\help\HelpTopicPluginInterface::isTopLevel()

Returns whether this is a top-level topic or not.

Return value

bool TRUE if this is a topic that should be displayed on the Help topics list; FALSE if not.

1 method overrides HelpTopicPluginInterface::isTopLevel()
HelpTopicPluginBase::isTopLevel in core/modules/help_topics/src/HelpTopicPluginBase.php
Returns whether this is a top-level topic or not.

File

core/modules/help_topics/src/HelpTopicPluginInterface.php, line 44

Class

HelpTopicPluginInterface
Defines an interface for help topic plugin classes.

Namespace

Drupal\help_topics

Code

public function isTopLevel();

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