hook_search_preprocess

  1. drupal
    1. 5
    2. 8 search.api.php
    3. 6
    4. 7 search.api.php
Versions
5 – 6 hook_search_preprocess($text)

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

Code

documentation/developer/hooks/core.php, line 1295

<?php
function hook_search_preprocess($text) {
  // Do processing on $text
  return $text;
}
?>