1 search.module search_get_info($all = FALSE)

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).

File

core/modules/search/search.module, line 312
Enables site-wide keyword searching.

Code

function search_get_info($all = FALSE) {
  $search_hooks = &backdrop_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;
  }

  // Return only modules that are set to active in search settings.
  return array_intersect_key($search_hooks, array_flip((array) config_get('search.settings', 'search_active_modules')));
}