devaloka/mu-plugin-installer

A Composer Installer for WordPress MU plugins

A Composer Installer for WordPress MU Plugins

![Build Status][travis-image] ![Coverage Status][coveralls-image], _(*1)

This is a Composer Installer for WordPress MU Plugins., _(*2)

The Installer is basically based on/compatible with A Multi-Framework Composer Library Installer but it also supports the loader script installation of your MU plugin., _(*3)

The loader script is installed into mu-plugins directory by default so that you can provide your MU plugin including sub directory as a Composer package., _(*4)

Example

A package:, _(*5)

• your-package-root, _(*6)

  • mu-plugins/ (loader directory: mu-plugins by default), _(*7)

    • your-plugin.php (loader script: same as your package name by default)

  • foo/, _(*8)

    • bar.php

  • baz.php, _(*9)

will be installed as:, _(*10)

• wp-content/mu-plugins/, _(*11)

  • your-plugin.php (loader script), _(*12)

  • your-plugin/ (same as your package name by default), _(*13)

    • mu-plugins/ (original loader directory remains), _(*14)

      • your-plugin.php (original loader script remains)

    • foo/, _(*15)

      • bar.php

    • baz.php, _(*16)

Example composer.json File (for MU plugin package)

composer.json becomes almost the same as A Multi-Framework Composer Library Installer's., _(*17)

Package Type and Dependency (type and require)

{
    "name": "you/your-plugin-name",
    "type": "devaloka-muplugin",
    "require": {
        "devaloka/mu-plugin-installer": "~0.2.0"
    }
}

Custom Loader File (installer-loader)

installer-loader key is available for your custom loader file, which is the relative path from your package root., _(*18)

{
    "extra": {
        "installer-loader": "loader/your-loader.php"
    }
}

You can check out a real world composer.json example., _(*19)

Example composer.json File (for root package)

The root package means your project's composer.json., _(*20)

Custom Loader Path (installer-loader-paths)

installer-loader-paths key is available for your custom install path for loader(s)., _(*21)

This is almost the same as as A Multi-Framework Composer Library Installer's installer-paths but it is for the loader file., _(*22)

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

With a type: prefix:, _(*23)

{
    "extra": {
        "installer-loader-paths": {
            "your-custom-path/{$name}/": ["type:devaloka-muplugin"]
        }
    }
}

{$vendor}, {$name} and {$type} variables are available., _(*24)

In addition, {$loader} variable is available, which is the relative path to the loader file., _(*25)