function module_disable

Disables a given set of modules.

Parameters

array $module_list: An array of module names.

bool $disable_dependents: (optional)

• If TRUE, dependency-checking is enabled. This means that any modules dependent on the passed-in module(s) will be automatically added and disabled in the correct order. Note that dependency-checking incurs a significant performance cost.
• If FALSE, dependency-checking is bypassed and dependent modules will not be automatically added or disabled. This could lead to problems, and so should only be used if you know $module_list is already complete and in the correct order.

See also

backdrop_uninstall_modules()

module_enable()

File

core/includes/module.inc, line 562

API for loading and interacting with Backdrop modules.

Code

function module_disable($module_list, $disable_dependents = TRUE) {
  if ($disable_dependents) {
    // Get all module data so we can find dependents and sort.
    $module_data = system_rebuild_module_data();
    // Create an associative array with weights as values.
    $module_list = array_flip(array_values($module_list));

    $profile = backdrop_get_profile();
    // The array is iterated over manually (instead of using a foreach) because
    // modules may be added to the list within the loop and we need to process
    // them.
    while ($module = key($module_list)) {
      next($module_list);
      if (!isset($module_data[$module]) || !$module_data[$module]->status) {
        // This module doesn't exist or is already disabled, skip it.
        unset($module_list[$module]);
        continue;
      }
      $module_list[$module] = $module_data[$module]->sort;

      // Add dependent modules to the list, with a placeholder weight.
      // The new modules will be processed as the while loop continues.
      foreach ($module_data[$module]->required_by as $dependent => $dependent_data) {
        if (!isset($module_list[$dependent]) && $dependent != $profile) {
          $module_list[$dependent] = 0;
        }
      }
    }

    // Sort the module list by pre-calculated weights.
    asort($module_list);
    $module_list = array_keys($module_list);
  }

  // Refresh Entity info static cache.
  entity_info_cache_clear();

  $invoke_modules = array();

  foreach ($module_list as $module) {
    if (module_exists($module)) {
      module_load_install($module);
      module_invoke($module, 'disable');
      db_update('system')
        ->fields(array('status' => 0))
        ->condition('type', 'module')
        ->condition('name', $module)
        ->execute();
      $invoke_modules[] = $module;
      watchdog('system', '%module module disabled.', array('%module' => $module), WATCHDOG_INFO);
    }
  }

  if (!empty($invoke_modules)) {
    // Refresh the module list to exclude the disabled modules.
    system_list_reset();
    module_list(TRUE);
    module_implements_reset();
    // Invoke hook_modules_disabled before disabling modules,
    // so we can still call module hooks to get information.
    module_invoke_all('modules_disabled', $invoke_modules);
    // Update the registry to remove the newly-disabled module.
    backdrop_static_reset('backdrop_autoload');
    _system_update_bootstrap_status();
    // Update the theme registry to remove the newly-disabled module.
    backdrop_theme_rebuild();
  }
}