PHPackages                             composer/installers - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. composer/installers

ActiveComposer-plugin[Framework](/categories/framework)

composer/installers
===================

A multi-framework Composer library installer

v2.3.0(1y ago)1.4k136.0M—0.1%402[16 issues](https://github.com/composer/installers/issues)[6 PRs](https://github.com/composer/installers/pulls)20MITPHPPHP ^7.2 || ^8.0CI passing

Since Sep 8Pushed 1mo ago45 watchersCompare

[ Source](https://github.com/composer/installers)[ Packagist](https://packagist.org/packages/composer/installers)[ Docs](https://composer.github.io/installers/)[ Fund](https://packagist.com)[ GitHub Sponsors](https://github.com/composer)[ RSS](/packages/composer-installers/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (7)Versions (48)Used By (20)

A Multi-Framework [Composer](http://getcomposer.org) Library Installer
======================================================================

[](#a-multi-framework-composer-library-installer)

[![Continuous Integration](https://github.com/composer/installers/workflows/Continuous%20Integration/badge.svg?branch=main)](https://github.com/composer/installers/actions)

This is for PHP package authors to require in their `composer.json`. It will install their package to the correct location based on the specified package type.

The goal of Installers is to be a simple package type to install path map. Users can also customize the install path per package and package authors can modify the package name upon installing.

Installers isn't intended on replacing all custom installers. If your package requires special installation handling then by all means, [create a custom installer to handle it](https://getcomposer.org/doc/articles/custom-installers.md).

**Natively Supported Frameworks**:

Most frameworks these days natively work with Composer and will be installed to the default `vendor` directory. `composer/installers`is **not needed** to install packages with these frameworks.

Alternative to custom installers with Composer 2.1+
---------------------------------------------------

[](#alternative-to-custom-installers-with-composer-21)

As of Composer 2.1, the `Composer\InstalledVersions` class has a [`getInstalledPackagesByType`](https://getcomposer.org/doc/07-runtime.md#knowing-which-packages-of-a-given-type-are-installed)method which can let you figure out at runtime which plugins/modules/extensions are installed.

It is highly recommended to use that instead of building new custom installers if you are building a new application. This has the advantage of leaving all vendor code in the vendor directory, and not requiring custom installer code.

Current Supported Package Types
-------------------------------

[](#current-supported-package-types)

> Stable types are marked as **bold**, this means that installation paths for those type will not be changed. Any adjustment for those types would require creation of brand new type that will cover required changes.

FrameworkTypesAkaunting`akaunting-module`Asgard`asgard-module`
`asgard-theme`Attogram`attogram-module`AGL`agl-module`Bonefish`bonefish-package`Botble`botble-plugin`
`botble-theme`AnnotateCms`annotatecms-module`
`annotatecms-component`
`annotatecms-service`Bitrix`bitrix-module` (deprecated)
`bitrix-component` (deprecated)
`bitrix-theme` (deprecated)

 `bitrix-d7-module`
 `bitrix-d7-component`
 `bitrix-d7-template`CakePHP 2+**`cakephp-plugin`**Chef`chef-cookbook`
`chef-role`CiviCrm`civicrm-ext`CCFramework`ccframework-ship`
`ccframework-theme`Cockpit`cockpit-module`CodeIgniter`codeigniter-library`
`codeigniter-third-party`
`codeigniter-module`concrete5`concrete5-core`
`concrete5-package`
`concrete5-theme`
`concrete5-block`
`concrete5-update`ConcreteCMS`concretecms-core`
`concretecms-package`
`concretecms-theme`
`concretecms-block`
`concretecms-update`Croogo`croogo-plugin`
`croogo-theme`Decibel`decibel-app`Dframe`dframe-module`DokuWiki`dokuwiki-plugin`
`dokuwiki-template`Dolibarr`dolibarr-module`Drupal**`drupal-core`
`drupal-module`
`drupal-theme`**
`drupal-library`
`drupal-profile`
`drupal-database-driver`
`drupal-drush`
`drupal-custom-theme`
`drupal-custom-module`
`drupal-custom-profile`
`drupal-drupal-multisite`
`drupal-console`
`drupal-console-language`
`drupal-config`
`drupal-recipe`Elgg`elgg-plugin`Eliasis`eliasis-component`
`eliasis-module`
`eliasis-plugin`
`eliasis-template`ExpressionEngine 3`ee3-addon`
`ee3-theme`eZ Platform`ezplatform-assets`
`ezplatform-meta-assets`ForkCMS ^v6.x`fork-cms-module`
`fork-cms-theme`FuelPHP v1.x`fuel-module`
`fuel-package`
`fuel-theme`FuelPHP v2.x`fuelphp-component`Grav`grav-plugin`
`grav-theme`Hurad`hurad-plugin`
`hurad-theme`ImageCMS`imagecms-template`
`imagecms-module`
`imagecms-library`iTop`itop-extension`Kanboard`kanboard-plugin`Known`known-plugin`
`known-theme`
`known-console`KodiCMS`kodicms-plugin`
`kodicms-media`Kohana**`kohana-module`**Lan Management System`lms-plugin`
`lms-template`
`lms-document-template`
`lms-userpanel-module`Laravel`laravel-library`Lavalite`lavalite-theme`
`lavalite-package`Lithium**`lithium-library`
`lithium-source`**Magento`magento-library`
`magento-skin`
`magento-theme`majima`majima-plugin`Mako`mako-package`MantisBT`mantisbt-plugin`Matomo`matomo-plugin`Mautic`mautic-core`
`mautic-plugin`
`mautic-theme`Maya`maya-module`MODX`modx-extra`MODX Evo`modxevo-snippet`
`modxevo-plugin`
`modxevo-module`
`modxevo-template`
`modxevo-lib`MediaWiki`mediawiki-extension`Miaoxing`miaoxing-plugin`October**`october-module`
`october-plugin`
`october-theme`**OntoWiki`ontowiki-extension`
`ontowiki-theme`
`ontowiki-translation`OXID`oxid-module`
`oxid-theme`
`oxid-out`Osclass`osclass-plugin`
`osclass-theme`
`osclass-language`MODULEWork`modulework-module`Moodle`moodle-*` (Please [check source](https://github.com/composer/installers/blob/main/src/Composer/Installers/MoodleInstaller.php) for all supported types)Pantheon`quicksilver-script`
`quicksilver-module`Piwik`piwik-plugin`Phifty`phifty-bundle`
`phifty-framework`
`phifty-library`phpBB`phpbb-extension`
`phpbb-style`
`phpbb-language`Plentymarkets`plentymarkets-plugin`PPI**`ppi-module`**Prestashop`prestashop-module`
`prestashop-theme`Puppet`puppet-module`Porto`porto-container`ProcessWire`processwire-module`RadPHP`radphp-bundle`REDAXO`redaxo-addon`REDAXO bestyle-plugin`redaxo-bestyle-plugin`REDAXO V5.\*`redaxo5-addon`REDAXO V5.\* bestyle-plugin`redaxo5-bestyle-plugin`ReIndex**`reindex-plugin`**
 **`reindex-theme`**Roundcube`roundcube-plugin`shopware`shopware-backend-plugin`
`shopware-core-plugin`
`shopware-frontend-plugin`
`shopware-theme`
`shopware-plugin`
`shopware-frontend-theme`SilverStripe`silverstripe-module`
`silverstripe-theme`SiteDirect`sitedirect-module`
`sitedirect-plugin`SMF`smf-module`
`smf-theme`Starbug`starbug-module`
`starbug-theme`
`starbug-custom-module`
`starbug-custom-theme`SyDES`sydes-module`
`sydes-theme`Sylius`sylius-theme`TAO`tao-extension`TastyIgniter**`tastyigniter-module`
`tastyigniter-extension`
`tastyigniter-theme`**Tusk`tusk-task`
`tusk-command`
`tusk-asset`UserFrosting`userfrosting-sprinkle`Vanilla`vanilla-plugin`
`vanilla-theme`Vgmcp`vgmcp-bundle`
`vgmcp-theme`WHMCS`whmcs-addons`
`whmcs-fraud`
`whmcs-gateways`
`whmcs-notifications`
`whmcs-registrars`
`whmcs-reports`
`whmcs-security`
`whmcs-servers`
`whmcs-social`
`whmcs-support`
`whmcs-templates`
`whmcs-includes`Winter CMS**`winter-module`
`winter-plugin`
`winter-theme`**Wolf CMS`wolfcms-plugin`WordPress**`wordpress-plugin`
`wordpress-theme`**
`wordpress-muplugin`
`wordpress-dropin`YAWIK`yawik-module`Zend`zend-library`
`zend-extra`
`zend-module`Zikula`zikula-module`
`zikula-theme`Example `composer.json` File
----------------------------

[](#example-composerjson-file)

This is an example for a CakePHP plugin. The only important parts to set in your composer.json file are `"type": "cakephp-plugin"` which describes what your package is and `"require": { "composer/installers": "~1.0" }` which tells composer to load the custom installers.

```
{
    "name": "you/ftp",
    "type": "cakephp-plugin",
    "require": {
        "composer/installers": "~1.0"
    }
}
```

This would install your package to the `Plugin/Ftp/` folder of a CakePHP app when a user runs `php composer.phar install`.

So submit your packages to [packagist.org](http://packagist.org)!

Custom Install Paths
--------------------

[](#custom-install-paths)

If you are requiring a package which has one of the supported types you can override the install path with the following extra in your `composer.json`:

```
{
    "extra": {
        "installer-paths": {
            "your/custom/path/{$name}/": ["shama/ftp", "vendor/package"]
        }
    }
}
```

You can determine a non-standard installation path for all packages of a particular type with the `type:` prefix. The type must be one of types listed on the supported list above.

```
{
    "extra": {
        "installer-paths": {
            "your/custom/path/{$name}/": ["type:wordpress-plugin"]
        }
    }
}
```

You can also install all packages by a particular vendor to a custom installation path by using the `vendor:` prefix. The path will still only apply to packages by the vendor with a type in the supported list.

```
{
    "extra": {
        "installer-paths": {
            "your/custom/path/{$name}/": ["vendor:my_organization"]
        }
    }
}
```

These would use your custom path for each of the matching packages. The available variables to use in your paths are: `{$name}`, `{$vendor}`, `{$type}`.

**Note:** If multiple custom installer-paths match for the same package, the first one which matches will be used.

Custom Install Names
--------------------

[](#custom-install-names)

If you're a package author and need your package to be named differently when installed consider using the `installer-name` extra.

For example you have a package named `shama/cakephp-ftp` with the type `cakephp-plugin`. Installing with `composer/installers` would install to the path `Plugin/CakephpFtp`. Due to the strict naming conventions, you as a package author actually need the package to be named and installed to `Plugin/Ftp`. Using the following config within your **package** `composer.json`will allow this:

```
{
    "name": "shama/cakephp-ftp",
    "type": "cakephp-plugin",
    "extra": {
        "installer-name": "Ftp"
    }
}
```

Please note the name entered into `installer-name` will be the final and will not be inflected.

Disabling installers
--------------------

[](#disabling-installers)

There may be time when you want to disable one or more installers from `composer/installers`. For example, if you are managing a package or project that uses a framework specific installer that conflicts with `composer/installers` but also have a dependency on a package that depends on `composer/installers`.

Installers can be disabled for your project by specifying the extra `installer-disable` property. If set to `true`, `"all"`, or `"*"` all installers will be disabled.

```
{
    "extra": {
        "installer-disable": true
    }
}
```

Otherwise a single installer or an array of installers may be specified.

```
{
    "extra": {
        "installer-disable": [
            "cakephp",
            "drupal"
        ]
    }
}
```

**Note:** Using a global disable value (`true`, `"all"`, or `"*"`) will take precedence over individual installer names if used in an array. The example below will disable all installers.

```
{
    "extra": {
        "installer-disable": [
          "drupal",
          "all"
        ]
    }
}
```

Should we allow dynamic package types or paths? No
--------------------------------------------------

[](#should-we-allow-dynamic-package-types-or-paths-no)

What are they? The ability for a package author to determine where a package will be installed either through setting the path directly in their `composer.json` or through a dynamic package type: `"type": "framework-install-here"`.

It has been proposed many times. Even implemented once early on and then removed. Installers won't do this because it would allow a single package author to wipe out entire folders without the user's consent. That user would then come here to yell at us.

Anyone still wanting this capability should consider requiring .

###  Health Score

75

—

ExcellentBetter than 100% of packages

Maintenance66

Regular maintenance activity

Popularity80

Widely adopted with strong download metrics

Community67

Healthy contributor diversity

Maturity81

Battle-tested with a long release history

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~95 days

Recently: every ~207 days

Total

46

Last Release

693d ago

Major Versions

v1.11.0 → v2.0.0-alpha12021-07-23

v1.12.0 → v2.0.12021-09-13

1.x-dev → v2.1.02022-03-18

### Community

Maintainers

![](https://www.gravatar.com/avatar/b69782e1d7f426ef78f61d159c466a536372eff931f13981ac578fa3f4649352?d=identicon)[Seldaek](/maintainers/Seldaek)

![](https://www.gravatar.com/avatar/e4a500fc54ee3efd3d4febd755f4f32eea4799bc55c3afd62aade51b1ae10693?d=identicon)[shama](/maintainers/shama)

---

Top Contributors

[![shama](https://avatars.githubusercontent.com/u/99604?v=4)](https://github.com/shama "shama (145 commits)")[![Seldaek](https://avatars.githubusercontent.com/u/183678?v=4)](https://github.com/Seldaek "Seldaek (99 commits)")[![niksamokhvalov](https://avatars.githubusercontent.com/u/8028275?v=4)](https://github.com/niksamokhvalov "niksamokhvalov (65 commits)")[![thomscode](https://avatars.githubusercontent.com/u/2176970?v=4)](https://github.com/thomscode "thomscode (17 commits)")[![alcohol](https://avatars.githubusercontent.com/u/21414?v=4)](https://github.com/alcohol "alcohol (15 commits)")[![torvitas](https://avatars.githubusercontent.com/u/4253100?v=4)](https://github.com/torvitas "torvitas (13 commits)")[![strausmann](https://avatars.githubusercontent.com/u/4519228?v=4)](https://github.com/strausmann "strausmann (9 commits)")[![atkrad](https://avatars.githubusercontent.com/u/351364?v=4)](https://github.com/atkrad "atkrad (8 commits)")[![dedalozzo](https://avatars.githubusercontent.com/u/311248?v=4)](https://github.com/dedalozzo "dedalozzo (7 commits)")[![GromNaN](https://avatars.githubusercontent.com/u/400034?v=4)](https://github.com/GromNaN "GromNaN (7 commits)")[![sagikazarmark](https://avatars.githubusercontent.com/u/1226384?v=4)](https://github.com/sagikazarmark "sagikazarmark (5 commits)")[![michaelmeneses](https://avatars.githubusercontent.com/u/6410303?v=4)](https://github.com/michaelmeneses "michaelmeneses (5 commits)")[![rchavik](https://avatars.githubusercontent.com/u/39490?v=4)](https://github.com/rchavik "rchavik (5 commits)")[![RobLoach](https://avatars.githubusercontent.com/u/25086?v=4)](https://github.com/RobLoach "RobLoach (5 commits)")[![kyletaylored](https://avatars.githubusercontent.com/u/1759794?v=4)](https://github.com/kyletaylored "kyletaylored (5 commits)")[![sampoyigi](https://avatars.githubusercontent.com/u/6567634?v=4)](https://github.com/sampoyigi "sampoyigi (5 commits)")[![KorvinSzanto](https://avatars.githubusercontent.com/u/1007419?v=4)](https://github.com/KorvinSzanto "KorvinSzanto (4 commits)")[![butschster](https://avatars.githubusercontent.com/u/773481?v=4)](https://github.com/butschster "butschster (4 commits)")[![carusogabriel](https://avatars.githubusercontent.com/u/16328050?v=4)](https://github.com/carusogabriel "carusogabriel (4 commits)")[![daftspunk](https://avatars.githubusercontent.com/u/1392869?v=4)](https://github.com/daftspunk "daftspunk (4 commits)")

---

Tags

laravelwordpressdrupalinstallerzendpiwikcakephpcodeigniterfuelphplithiumphpbbsyliusppisilverstripemoodlekohanamakomagentoaglroundcubemediawikichefcroogodokuwikipuppetmoduleworkannotatecmsbitrixzikulaWhmcsexpressionengineconcrete5processwiremodxelggHuradshopwareMODX EvoOXIDWolfCMSlavaliteDolibarrSMFgravTheliaMantisBTcockpitpantheonRadPHPitopsydesreindexMauticyawikImageCMSattogramtastyignitermiaoxingPlentymarketsKanboardPortoconcreteCMSeZ PlatformMayaEliasisosclassLan Management SystemmajimapxcmsmatomoknownStarbug

###  Code Quality

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/composer-installers/health.svg)

```
[![Health](https://phpackages.com/badges/composer-installers/health.svg)](https://phpackages.com/packages/composer-installers)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)