The Drupal search interface manages a global search mechanism.
Modules may plug into this system to provide searches of different types of data. Most of the system is handled by the Search module, so this must be enabled for all of the search features to work.
There are three ways to interact with the search system:
If your module needs to provide a more complicated search form, then you need to implement it yourself without hook_search_info(). In that case, you should define it as a local task (tab) under the /search page (e.g. /search/mymodule) so that users can easily find it.
Name | Location | Description |
---|---|---|
hook_search_info |
drupal/ |
Define a custom search type. |
hook_search_access |
drupal/ |
Define access to a custom search routine. |
hook_search_reset |
drupal/ |
Take action when the search index is going to be rebuilt. |
hook_search_status |
drupal/ |
Report the status of indexing. |
hook_search_admin |
drupal/ |
Add elements to the search settings form. |
hook_search_execute |
drupal/ |
Execute a search for a set of key words. |
hook_search_preprocess |
drupal/ |
Preprocess text for search. |
hook_update_index |
drupal/ |
Update the search index for this module. |
callback_search_conditions |
drupal/ |
Provide search query conditions. |
search_index |
drupal/ |
Updates the full-text search index for a particular item. |
search_form |
drupal/ |
Form constructor for the search form. |
search_box |
drupal/ |
Form constructor for the search block's search box. |
search_box_form_submit |
drupal/ |
Form submission handler for search_box(). |
search_data |
drupal/ |
Performs a search by calling hook_search_execute(). |
search_excerpt |
drupal/ |
Returns snippets from a piece of text, with certain keywords highlighted. |