interface ModuleUninstallValidatorInterface

Common interface for module uninstall validators.

A module uninstall validator must implement this interface and be defined in a Drupal service that is tagged module_install.uninstall_validator. If autoconfiguration is enabled, the service will be automatically tagged.

Validators are called during module uninstall and prior to running a configuration import. If different logic is required when uninstalling via configuration import implement ConfigImportModuleUninstallValidatorInterface.

Hierarchy

• interface \Drupal\Core\Extension\ModuleUninstallValidatorInterface

Expanded class hierarchy of ModuleUninstallValidatorInterface

All classes that implement ModuleUninstallValidatorInterface

See also

\Drupal\Core\Extension\ModuleInstaller::validateUninstall()

\Drupal\Core\EventSubscriber\ConfigImportSubscriber::validateModules()

\Drupal\Core\Extension\ConfigImportModuleUninstallValidatorInterface

File

core/lib/Drupal/Core/Extension/ModuleUninstallValidatorInterface.php, line 21

Namespace

interface ModuleUninstallValidatorInterface {
    
    /**
     * Determines the reasons a module can not be uninstalled.
     *
     * @param string $module
     *   A module name.
     *
     * @return string[]
     *   An array of reasons the module can not be uninstalled, empty if it can.
     *   Each reason should not end with any punctuation since multiple reasons
     *   can be displayed together.
     *
     * @see template_preprocess_system_modules_uninstall()
     */
    public function validate($module);

}

Members