Execute a search for a set of key words.

Use database API with the 'PagerDefault' query extension to perform your search.

If your module uses hook_update_index() and search_index() to index its items, use table 'search_index' aliased to 'i' as the main table in your query, with the 'SearchQuery' extension. You can join to your module's table using the 'i.sid' field, which will contain the $sid values you provided to search_index(). Add the main keywords to the query by using method searchExpression(). The functions search_expression_extract() and search_expression_insert() may also be helpful for adding custom search parameters to the search expression.

See node_search_execute() for an example of a module that uses the search index, and user_search_execute() for an example that doesn't use the search index.

Parameters

$keys: The search keywords as entered by the user.

$conditions: An optional array of additional conditions, such as filters.

Return value

An array of search results. To use the default search result display, each item should have the following keys':

• 'link': Required. The URL of the found item.
• 'type': The type of item (such as the content type).
• 'title': Required. The name of the item.
• 'user': The author of the item.
• 'date': A timestamp when the item was last modified.
• 'extra': An array of optional extra information items.
• 'snippet': An excerpt or preview to show with the result (can be generated with search_excerpt()).
• 'language': Language code for the item (usually two characters).

Related topics

3 functions implement hook_search_execute()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

node_search_execute in modules/node/node.module

Implements hook_search_execute().

search_extra_type_search_execute in modules/search/tests/search_extra_type.module

Implements hook_search_execute().

user_search_execute in modules/user/user.module

Implements hook_search_execute().

1 invocation of hook_search_execute()

search_data in modules/search/search.module

Performs a search by calling hook_search_execute().

File

modules/search/search.api.php, line 171

Code

function hook_search_execute($keys = NULL, $conditions = NULL) {
    // Build matching conditions
    $query = db_select('search_index', 'i', array(
        'target' => 'slave',
    ))->extend('SearchQuery')
        ->extend('PagerDefault');
    $query->join('node', 'n', 'n.nid = i.sid');
    $query->condition('n.status', 1)
        ->addTag('node_access')
        ->searchExpression($keys, 'node');
    // Insert special keywords.
    $query->setOption('type', 'n.type');
    $query->setOption('language', 'n.language');
    if ($query->setOption('term', 'ti.tid')) {
        $query->join('taxonomy_index', 'ti', 'n.nid = ti.nid');
    }
    // Only continue if the first pass query matches.
    if (!$query->executeFirstPass()) {
        return array();
    }
    // Add the ranking expressions.
    _node_rankings($query);
    // Load results.
    $find = $query->limit(10)
        ->execute();
    $results = array();
    foreach ($find as $item) {
        // Build the node body.
        $node = node_load($item->sid);
        node_build_content($node, 'search_result');
        $node->body = drupal_render($node->content);
        // Fetch comments for snippet.
        $node->rendered .= ' ' . module_invoke('comment', 'node_update_index', $node);
        // Fetch terms for snippet.
        $node->rendered .= ' ' . module_invoke('taxonomy', 'node_update_index', $node);
        $extra = module_invoke_all('node_search_result', $node);
        $results[] = array(
            'link' => url('node/' . $item->sid, array(
                'absolute' => TRUE,
            )),
            'type' => check_plain(node_type_get_name($node)),
            'title' => $node->title,
            'user' => theme('username', array(
                'account' => $node,
            )),
            'date' => $node->changed,
            'node' => $node,
            'extra' => $extra,
            'score' => $item->calculated_score,
            'snippet' => search_excerpt($keys, $node->body),
        );
    }
    return $results;
}

---