Modules / $modules

// Is module installed?
if($modules->isInstalled('ModuleName')) { ... }

// Is module installable (file on disk, not yet installed)?
if($modules->isInstallable('ModuleName')) { ... }
if($modules->isInstallable('ModuleName', true)) { ... } // true = all deps also available now

// Does the module load automatically at boot?
if($modules->isAutoload($module)) { ... }

// Does the module support only a single instance at runtime?
if($modules->isSingular($module)) { ... }

// Is the module interactively configurable?
if($modules->isConfigurable('ModuleName')) { ... }

// Install a module — also installs dependencies by default
$module = $modules->install('ModuleName');
$module = $modules->install('ModuleName', [
    'dependencies' => true,  // also install uninstalled dependencies (default=true)
    'resetCache'   => true,  // reset module info cache after install (default=true)
    'force'        => false, // install even if dependencies can't be met (default=false)
]);

// Uninstall a module (returns bool)
$modules->uninstall('ModuleName');

// Physically delete a module's files from disk (must be uninstalled first)
$modules->delete('ModuleName');

// Refresh modules list — picks up new, moved, or changed module files on disk
$modules->refresh();
$modules->refresh(true); // show admin notice messages about what changed

// Get all config data for a module
$data = $modules->getConfig('HelloWorld');

// Get a single config property
$apiKey = $modules->getConfig('HelloWorld', 'apiKey');

// Save all config data
$data = $modules->getConfig('HelloWorld');
$data['greeting'] = 'Hello!';
$modules->saveConfig('HelloWorld', $data);

// Save a single config property (key, value form)
$modules->saveConfig('HelloWorld', 'greeting', 'Hello!');

// Get URL to the module's config/edit screen in the admin
$url = $modules->getModuleEditUrl('ModuleName');

// Get URL to install a module (or its edit screen if already installed)
$url = $modules->getModuleInstallUrl('ModuleName');

The following commands are available from the command line (run from the ProcessWire root directory):

php index.php modules list [site|core]              List installed modules (optionally limit to site or core)
php index.php modules unlist [site|core]            List uninstalled modules (optionally limit to site or core)
php index.php modules info <name> [property]        Get all info for a module as JSON, or a single info property
php index.php modules install <name>                Install a module
php index.php modules uninstall <name>              Uninstall a module
php index.php modules exists <name>                 Does the class name resolve to a module? (Yes/No)
php index.php modules installed <name>              Is the module installed? (Yes/No)
php index.php modules config <name>                 Get module configuration data as JSON
php index.php modules config <name> <property>      Get a single module config property value
php index.php modules dir <name>                    Query the ProcessWire modules directory for module info
php index.php modules updates [name]                List available updates for site modules, or check one
php index.php modules download <name> [--install]   Download module from the PW modules directory
php index.php modules download <url> [--install]    Download a module ZIP from an https URL
php index.php modules update <name> [--force]       Download and apply an available module update
php index.php modules delete <name>                 Delete an uninstalled module's files from disk

Append --json to any command for verbose JSON output.

• $modules->get() and property access auto-install a module if its file is present but not yet installed. Pass 'noInstall' => true to getModule() to prevent this.
• When iterating $modules directly, items may be ModulePlaceholder instances rather than real modules. Call $modules->get($name) to get the real instantiated module.
• All write methods (install, uninstall, delete, saveConfig, refresh) are hookable via the triple-underscore ___methodName() pattern.
• getConfig() / saveConfig() replaced the older getModuleConfigData() / saveModuleConfigData() names in ProcessWire 3.0.16. Both names still work.

Please see [[Module]] for details on the Module interface, the different types of modules, and to learn more about how to create modules.