Advanced Custom Fields Pro Composer Bridge

This repository acts as a bridge to use the excellent Advanced Custom Fields Pro
Wordpress plugin together with Composer/Bedrock.

⚠️ Repository shutting down on 1st of June 2023 ⚠️

Since Advanced Custom Fields has released native support for Composer 🎉 this repository is deprecated. We actively encourage users to switch to their solution. This repository (and our installer) is maintained till the 1st of June 2023 to provide a transition period. Afterwards we will permanently shut the repository down.

Finally, we would like to thank you all for your support!

Breaking change between v2 and V3

As composer/installers is added to the dependencies of all provided packages, the default installation folder is changed.
It is recommended to switch to V3, but ensure ACF Pro ends up in the folder you except when installing to ensure your code does not break. This composer manual page describes how to modify the install path. You can find a few examples at the end of this readme.

How to install

1. Add the desired repository to the repositories field in composer.json

Select one of the following repositories based on the desired plugin type:

Wordpress Packagist plugin

Use this version if you are unsure which version to use.

{
  "type": "composer",
  "url": "https://pivvenit.github.io/acf-composer-bridge/composer/v3/wordpress-plugin/"
}

Wordpress Packagist Must-Use plugin

Use this version if you want ACF installed as MU-plugin.

{
  "type": "composer",
  "url": "https://pivvenit.github.io/acf-composer-bridge/composer/v3/wordpress-muplugin/"
}

Wordpress wpackagist plugin type

Use this repository URL if you use the (seemingly deprecated) wpackagist-plugin plugin type.

{
  "type": "composer",
  "url": "https://pivvenit.github.io/acf-composer-bridge/composer/v3/wpackagist-plugin/"
}

As regular composer dependency

To install the plugin in the vendor directory.

{
  "type": "composer",
  "url": "https://pivvenit.github.io/acf-composer-bridge/composer/v3/library/"
}

2. Make your ACF PRO key available

Set the environment variable ACF_PRO_KEY to your ACF PRO key.

Alternatively you can add an entry to your .env file:

# .env (same directory as composer.json)
ACF_PRO_KEY=Your-Key-Here

3. Require ACF PRO

You can now use composer as usual, to include any version of advanced-custom-fields-pro

composer require advanced-custom-fields/advanced-custom-fields-pro

How does it work

This Github repository is a ‘Composer repository’.
Actually a composer repository is simply a packages.json served from a webserver.
This repository uses Github Actions to periodically create a packages.json that references
the files provided by ACF. Please note that these files require a valid license key that is not provided by this repository.
In order to append this license key to the files, https://github.com/pivvenit/acf-pro-installer is used.
This installer detects that you want to install advanced custom fields, and then appends the provided private key (via environment variable) to the actual download URL on ACF’s servers (so the key is never send to this composer repository).

Available versions

See https://pivvenit.github.io/acf-composer-bridge/composer/v3/wpackagist-plugin/packages.json

Example(s)

1. Installs ACF Pro as mu-plugin in web/app/mu-plugins/advanced-custom-fields-pro

{
  "name": "example/test",
  "repositories": [
    {
      "type": "composer",
      "url": "https://pivvenit.github.io/acf-composer-bridge/composer/v3/wordpress-muplugin/"
    },
    {
      "type": "composer",
      "url": "https://wpackagist.org"
    }
  ],
  "require": {
    "advanced-custom-fields/advanced-custom-fields-pro": "^5.8.8"
  },
  "extra": {
    "installer-paths": {
      "web/app/mu-plugins/{$name}/": ["type:wordpress-muplugin"]
    }
  }
}

2. Installs ACF Pro as plugin in wp-content/plugins/advanced-custom-fields-pro

{
    "name": "example/test",
    "repositories": [
      {
        "type": "composer",
        "url": "https://pivvenit.github.io/acf-composer-bridge/composer/v3/wordpress-plugin/"
      },
      {
        "type": "composer",
        "url": "https://wpackagist.org"
      }
    ],
    "require": {
      "advanced-custom-fields/advanced-custom-fields-pro": "^5.8.8"
    },
    "extra": {
      "installer-paths": {
        "wp-content/plugins/{$name}/": ["type:wordpress-plugin"]
      }
    }
  }