function hook_search_page
hook_search_page($results)
Override the rendering of search results.
A module that implements hook_search_info() to define a type of search may implement this hook in order to override the default theming of its search results, which is otherwise themed using theme('search_results').
Note that by default, theme('search_results') and theme('search_result') work together to create an ordered list (OL). So your hook_search_page() implementation should probably do this as well.
Parameters
$results: An array of search results.
Return value
A renderable array, which will render the formatted search results with a pager included.
See also
Related topics
File
- modules/search/search.api.php, line 248
- Hooks provided by the Search module.
Code
function hook_search_page($results) { $output['prefix']['#markup'] = '<ol class="search-results">'; foreach ($results as $entry) { $output[] = array( '#theme' => 'search_result', '#result' => $entry, '#module' => 'my_module_name', ); } $output['suffix']['#markup'] = '</ol>' . theme('pager'); return $output; }
© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/modules!search!search.api.php/function/hook_search_page/7.x