Topic

Composer is the preferred dependency management solution for PHP. List your project's dependencies in a composer.json file and, after issuing a few commands in the CLI, Composer will automatically download your project's dependencies and setup autoloading for you. Composer is analogous to NPM in the node.js world, or Bundler in the Ruby world.

Drupal core uses Composer to manage non-Drupal dependencies like Guzzle, and PHPUnit to name a few. Some (and more all the time) contributed modules also use Composer to integrate 3rd party PHP libraries into Drupal.

We recommend using Composer whenever possible to manage Drupal core and contributed module code for your projects. While it is not, strictly speaking, required to use Composer, doing so will prevent you from running into an issue where some contributed modules will not function properly if they are not installed via Composer.

Additionally, we generally recommend using Composer to download all of a project's dependencies, and then committing them to a single repository versus rebuilding the codebase for each deployment

Example tasks

  • Install Drupal core from a Git repository clone
  • Start a new Drupal site build
  • Download a contributed Drupal module that includes a composer library
  • Add a third-party PHP library as a dependency for your custom or contributed module

Confidence

The way that Composer is used to manage Drupal sites, and project dependencies, isn't likely to change significantly. We anticipate that it will continue to become the standard. And that the documentation available on Drupal.org will stay up-to-date with current best practices.

Drupalize.Me resources

  • The Wonderful World of Composer
    • Learn how to install and configure Composer and use it to integrate third-party libraries into any PHP project.
  • Composer Autoloading
    • Learn how to set up a PHP application to use Composer autoloading. Use this if you want to understand how the classes in libraries managed by composer can be automatically made available to a PHP application like Drupal via autoloading
  • Drupal Composer topic
    • This project provides help with many of the common initial project setup tasks including the installation of tools like Drush and Drupal Console, as well as setting the correct file permissions required to actually install Drupal.

More Guides

We have guides on many Drupal skills and topics.

Explore guides

External resources