Same name and namespace in other branches
  1. 10 core/modules/search/search.module \search_help()
  2. 4.6.x modules/search.module \search_help()
  3. 4.7.x modules/search.module \search_help()
  4. 5.x modules/search/search.module \search_help()
  5. 7.x modules/search/search.module \search_help()
  6. 8.9.x core/modules/search/search.module \search_help()
  7. 9 core/modules/search/search.module \search_help()

Implementation of hook_help().

File

modules/search/search.module, line 95
Enables site-wide keyword searching.

Code

function search_help($path, $arg) {
  switch ($path) {
    case 'admin/help#search':
      $output = '<p>' . t('The search module adds the ability to search for content by keywords. Search is often the only practical way to find content on a large site, and is useful for finding both users and posts.') . '</p>';
      $output .= '<p>' . t('To provide keyword searching, the search engine maintains an index of words found in your site\'s content. To build and maintain this index, a correctly configured <a href="@cron">cron maintenance task</a> is required. Indexing behavior can be adjusted using the <a href="@searchsettings">search settings page</a>; for example, the <em>Number of items to index per cron run</em> sets the maximum number of items indexed in each pass of a <a href="@cron">cron maintenance task</a>. If necessary, reduce this number to prevent timeouts and memory errors when indexing.', array(
        '@cron' => url('admin/reports/status'),
        '@searchsettings' => url('admin/settings/search'),
      )) . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@search">Search module</a>.', array(
        '@search' => 'http://drupal.org/handbook/modules/search/',
      )) . '</p>';
      return $output;
    case 'admin/settings/search':
      return '<p>' . t('The search engine maintains an index of words found in your site\'s content. To build and maintain this index, a correctly configured <a href="@cron">cron maintenance task</a> is required. Indexing behavior can be adjusted using the settings below.', array(
        '@cron' => url('admin/reports/status'),
      )) . '</p>';
    case 'search#noresults':
      return t('<ul>
<li>Check if your spelling is correct.</li>
<li>Remove quotes around phrases to match each word individually: <em>"blue smurf"</em> will match less than <em>blue smurf</em>.</li>
<li>Consider loosening your query with <em>OR</em>: <em>blue smurf</em> will match less than <em>blue OR smurf</em>.</li>
</ul>');
  }
}