You are here

public function SearchPluginBase::getGroupDescription in Search API Autocomplete 8

Retrieves a description for this search's group.

Searches with the same group label should aim to also return the same group description.

Return value

string A translated, human-readable description for this search's group.

Overrides SearchPluginInterface::getGroupDescription

File

src/Search/SearchPluginBase.php, line 95

Class

SearchPluginBase
Provides a base class for search plugins.

Namespace

Drupal\search_api_autocomplete\Search

Code

public function getGroupDescription() {
  $plugin_definition = $this
    ->getPluginDefinition();
  if (isset($plugin_definition['group_description'])) {
    return $plugin_definition['group_description'];
  }
  return $this
    ->t('Searches not belonging to any specific group');
}