The Backdrop 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 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:

  • Specifically for searching nodes, you can implement hook_node_update_index() and hook_node_search_result(). However, note that the search system already indexes all visible output of a node; i.e., everything displayed normally by hook_view() and hook_node_view(). This is usually sufficient. You should only use this mechanism if you want additional, non-visible data to be indexed.
  • Implement hook_search_info(). This will create a search tab for your module on the /search page with a simple keyword search form. You will also need to implement hook_search_execute() to perform the search.
  • Implement hook_update_index(). This allows your module to use Backdrop's HTML indexing mechanism for searching full text efficiently.

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/my_module), so that users know where to find it.


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


Namesort descending Location Description
callback_search_conditions core/modules/search/search.api.php Provide search query conditions.
hook_search_access core/modules/search/search.api.php Define access to a custom search routine.
hook_search_admin core/modules/search/search.api.php Add elements to the search settings form.
hook_search_execute core/modules/search/search.api.php Execute a search for a set of key words.
hook_search_info core/modules/search/search.api.php Define a custom search type.
hook_search_preprocess core/modules/search/search.api.php Preprocess text for search.
hook_search_reset core/modules/search/search.api.php Take action when the search index is going to be rebuilt.
hook_search_status core/modules/search/search.api.php Report the status of indexing.
hook_update_index core/modules/search/search.api.php Update the search index for this module.
search_box core/modules/search/search.module Form builder; Output a search form for the search block's search box.
search_box_form_submit core/modules/search/search.module Process a block search form submission.
search_data core/modules/search/search.module Performs a search by calling hook_search_execute().
search_excerpt core/modules/search/search.module Returns snippets from a piece of text, with certain keywords highlighted. Used for formatting search results.
search_form core/modules/search/search.module Builds a search form.
search_form_layout_block_configure_form_alter core/modules/search/search.module Implements hook_form_FORM_ID_alter().
search_index core/modules/search/search.module Update the full-text search index for a particular item.