function hook_search_preprocess

Same name and namespace in other branches
  1. 7.x drupal-7.x/modules/search/search.api.php \hook_search_preprocess()

Preprocess text for the search index.

This hook is called both for text added to the search index, as well as the keywords users have submitted for searching.

This is required for example to allow Japanese or Chinese text to be searched. As these languages do not use spaces, it needs to be split into separate words before it can be indexed. There are various external libraries for this.

Parameters

$text: The text to split. This is a single piece of plain-text that was extracted from between two HTML tags. Will not contain any HTML entities.

Return value

The text after processing.

Related topics

Hooks
Allow modules to interact with the Drupal core.
1 invocation of hook_search_preprocess()
search_invoke_preprocess in drupal-6.x/modules/search/search.module
Invokes hook_search_preprocess() in modules.

Archivo

documentation-6.x/developer/hooks/core.php, line 2023
These are the hooks that are invoked by the Drupal core.

Código

function hook_search_preprocess($text) {
  // Do processing on $text
  return $text;
}