Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Hooks provided by the Search module.
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * @addtogroup hooks
Chris@0:  * @{
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Preprocess text for search.
Chris@0:  *
Chris@0:  * This hook is called to preprocess both the text added to the search index
Chris@0:  * and the keywords users have submitted for searching. The same processing
Chris@0:  * needs to be applied to both so that searches will find matches.
Chris@0:  *
Chris@0:  * Possible uses:
Chris@0:  * - Adding spaces between words of Chinese or Japanese text.
Chris@0:  * - Stemming words down to their root words to allow matches between, for
Chris@0:  *   instance, walk, walked, walking, and walks in searching.
Chris@0:  * - Expanding abbreviations and acronyms that occur in text.
Chris@0:  *
Chris@0:  * @param string $text
Chris@0:  *   The text to preprocess. This is a single piece of plain text extracted
Chris@0:  *   from between two HTML tags or from the search query. It will not contain
Chris@0:  *   any HTML entities or HTML tags.
Chris@0:  * @param string|null $langcode
Chris@0:  *   The language code for the language the text is in, if known. When this hook
Chris@0:  *   is invoked during search indexing, the language will most likely be known
Chris@0:  *   and passed in. This is left up to the search plugin;
Chris@0:  *   \Drupal\node\Plugin\Search\NodeSearch does pass in the node
Chris@0:  *   language. However, when this hook is invoked during searching, in order to
Chris@0:  *   let a module apply the same preprocessing to the search keywords and
Chris@0:  *   indexed text so they will match, $langcode will be NULL. A hook
Chris@0:  *   implementation can call the getCurrentLanguage() method on the
Chris@0:  *   'language_manager' service to determine the current language and act
Chris@0:  *   accordingly.
Chris@0:  *
Chris@0:  * @return string
Chris@0:  *   The text after preprocessing. Note that if your module decides not to
Chris@0:  *   alter the text, it should return the original text. Also, after
Chris@0:  *   preprocessing, words in the text should be separated by a space.
Chris@0:  *
Chris@0:  * @ingroup search
Chris@0:  */
Chris@0: function hook_search_preprocess($text, $langcode = NULL) {
Chris@0:   // If the language is not set, get it from the language manager.
Chris@0:   if (!isset($langcode)) {
Chris@0:     $langcode = \Drupal::languageManager()->getCurrentLanguage()->getId();
Chris@0:   }
Chris@0: 
Chris@0:   // If the langcode is set to 'en' then add variations of the word "testing"
Chris@0:   // which can also be found during English language searches.
Chris@0:   if ($langcode == 'en') {
Chris@0:     // Add the alternate verb forms for the word "testing".
Chris@0:     if ($text == 'we are testing') {
Chris@0:       $text .= ' test tested';
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   return $text;
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alter search plugin definitions.
Chris@0:  *
Chris@0:  * @param array $definitions
Chris@0:  *   The array of search plugin definitions, keyed by plugin ID.
Chris@0:  *
Chris@0:  * @see \Drupal\search\Annotation\SearchPlugin
Chris@0:  * @see \Drupal\search\SearchPluginManager
Chris@0:  */
Chris@0: function hook_search_plugin_alter(array &$definitions) {
Chris@0:   if (isset($definitions['node_search'])) {
Chris@0:     $definitions['node_search']['title'] = t('Nodes');
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * @} End of "addtogroup hooks".
Chris@0:  */