function UserSearch::getHelp

Overrides SearchPluginBase::getHelp

File

core/modules/user/src/Plugin/Search/UserSearch.php, line 171

Class

UserSearch

Executes a keyword search for users against the {users} database table.

Namespace

Code

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;
}