function search_get_info

Returns information about available search modules.

Parameters

$all: If TRUE, information about all enabled modules implementing hook_search_info() will be returned. If FALSE (default), only modules that have been set to active on the search settings page will be returned.

Return value

Array of hook_search_info() return values, keyed by module name. The 'title' and 'path' array elements will be set to defaults for each module if not supplied by hook_search_info(), and an additional array element of 'module' will be added (set to the module name).

6 calls to search_get_info()
search_form in modules/search/search.module
Builds a search form.
search_get_default_module_info in modules/search/search.module
Returns information about the default search module.
search_is_active in modules/search/search.module
Determines access for the ?q=search path.
search_menu in modules/search/search.module
Implements hook_menu().
search_view in modules/search/search.pages.inc
Menu callback; presents the search form and/or search results.

... See full list

1 string reference to 'search_get_info'
search_menu in modules/search/search.module
Implements hook_menu().

File

modules/search/search.module, line 254

Code

function search_get_info($all = FALSE) {
    $search_hooks =& drupal_static(__FUNCTION__);
    if (!isset($search_hooks)) {
        foreach (module_implements('search_info') as $module) {
            $search_hooks[$module] = call_user_func($module . '_search_info');
            // Use module name as the default value.
            $search_hooks[$module] += array(
                'title' => $module,
                'path' => $module,
            );
            // Include the module name itself in the array.
            $search_hooks[$module]['module'] = $module;
        }
    }
    if ($all) {
        return $search_hooks;
    }
    $active = variable_get('search_active_modules', array(
        'node',
        'user',
    ));
    return array_intersect_key($search_hooks, array_flip($active));
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.