WPackagist

A free service that mirrors the WordPress® plugin and theme directories as a Composer repository. 1

How do I use it?

  1. Add the repository to your composer.json
  2. Add the desired plugins and themes to your requirements using wpackagist-plugin or wpackagist-theme as the vendor name.
  3. Run $ composer.phar update
  4. Packages are installed to wp-content/plugins/ or wp-content/themes/ (unless otherwise specified by installer-paths)

Example Usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
    "name": "acme/brilliant-wordpress-site",
    "description": "My brilliant WordPress site",
    "repositories":[
        {
            "name": "wpackagist",
            "type": "composer",
            "url": "https://wpackagist.org",
            "only": [
                "wpackagist-plugin/*",
                "wpackagist-theme/*"
            ]
        }
    ],
    "require": {
        "aws/aws-sdk-php":"*",
        "wpackagist-plugin/akismet":"dev-trunk",
        "wpackagist-plugin/advanced-custom-fields":">=6.7.1",
        "wpackagist-theme/frost":"*"
    },
    "autoload": {
        "psr-0": {
            "Acme": "src/"
        }
    },
    "extra": {
        "installer-paths": {
            "wp-content/mu-plugins/{$name}/": [
                "wpackagist-plugin/akismet"
            ],
            "wp-content/plugins/{$name}/": [
                "type:wordpress-plugin"
            ]
        }
    }
}

This example composer.json file adds the Wpackagist repository and includes the latest version of Akismet (installed as a must-use plugin), at least version 6.7.1 of Advanced Custom Fields, and the latest Frost theme along with the Amazon Web Services SDK from the main Packagist repository.

Find out more about using Composer including custom install paths.

The old vendor prefix wpackagist is now removed in favour of wpackagist-plugin.

Why use Composer?

“Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you.”

— getcomposer.org
  • Avoid committing plugins and themes into source control.
  • Avoid having to use git submodules.
  • Manage WordPress® and non-WordPress® project libraries with the same tools.
  • Could eventually be used to manage dependencies between plugins.

How does the repository work?

  • Scans the WordPress® Subversion repository every hour for plugins and themes. Search and click to make any newer versions available.
  • Fetches the tags for each updated package and maps those to versions.
  • For plugins, adds trunk as a dev version.
  • Rebuilds the composer package JSON files.

Known issues

  • Requires Composer 1.0.0-alpha7 or more recent
  • Version strings which Composer cannot parse are ignored. All plugins have at least the trunk build available.
  • Themes do not have a trunk version. It is recommended to use "*" as the required version.
  • Even when packages are present on SVN, they won’t be available if they are not published on wordpress.org. Try searching for your plugin before reporting a bug.
  • You can also check for open issues.

WordPress® Core

See fancyguy/webroot-installer or roots/wordpress for installing WordPress® itself using Composer.