function UserSearch::getHelp
Same name in other branches
- 9 core/modules/user/src/Plugin/Search/UserSearch.php \Drupal\user\Plugin\Search\UserSearch::getHelp()
- 8.9.x core/modules/user/src/Plugin/Search/UserSearch.php \Drupal\user\Plugin\Search\UserSearch::getHelp()
- 11.x core/modules/user/src/Plugin/Search/UserSearch.php \Drupal\user\Plugin\Search\UserSearch::getHelp()
Overrides SearchPluginBase::getHelp
File
-
core/
modules/ user/ src/ Plugin/ Search/ UserSearch.php, line 166
Class
- UserSearch
- Executes a keyword search for users against the {users} database table.
Namespace
Drupal\user\Plugin\SearchCode
public function getHelp() {
$help = [
'list' => [
'#theme' => 'item_list',
'#items' => [
$this->t('User search looks for user names and partial user names. Example: mar would match usernames mar, delmar, and maryjane.'),
$this->t('You can use * as a wildcard within your keyword. Example: m*r would match user names mar, delmar, and elementary.'),
],
],
];
return $help;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.