public function UserSearch::getHelp in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/modules/user/src/Plugin/Search/UserSearch.php \Drupal\user\Plugin\Search\UserSearch::getHelp()

Returns the searching help.

Return value

array Render array for the searching help.

Overrides SearchPluginBase::getHelp

File

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

Contains \Drupal\user\Plugin\Search\UserSearch.

Class

UserSearch

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

Namespace

Drupal\user\Plugin\Search

Code

public function getHelp() {
  $help = array(
    'list' => array(
      '#theme' => 'item_list',
      '#items' => array(
        $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;
}