function RecipeRunner::installModule

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Recipe/RecipeRunner.php \Drupal\Core\Recipe\RecipeRunner::installModule()
  2. 10 core/lib/Drupal/Core/Recipe/RecipeRunner.php \Drupal\Core\Recipe\RecipeRunner::installModule()

Installs a module for a recipe.

Parameters

string $module: The name of the module to install.

\Drupal\Core\Config\StorageInterface|\Drupal\Core\Recipe\Recipe $recipeConfigStorage: The recipe or recipe's config storage.

array<mixed>|null $context: The batch context if called by a batch.

Deprecated

in drupal:11.4.0 and is removed from drupal:13.0.0. Use \Drupal\Core\Recipe\RecipeRunner::installModules() instead.

See also

https://www.drupal.org/node/3579527

File

core/lib/Drupal/Core/Recipe/RecipeRunner.php, line 277

Class

RecipeRunner
Applies a recipe.

Namespace

Drupal\Core\Recipe

Code

public static function installModule(string $module, StorageInterface|Recipe $recipeConfigStorage, ?array &$context = NULL) : void {
  @trigger_error(__METHOD__ . ' is deprecated in drupal:11.4.0 and is removed from drupal:13.0.0. Use \\Drupal\\Core\\Recipe\\RecipeRunner::installModules() instead. See https://www.drupal.org/node/3579527', E_USER_DEPRECATED);
  static::installModules([
    $module,
  ], $recipeConfigStorage, $context);
}

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