Skip to content
A composer install helper for Advanced Custom Fields PRO
Branch: master
Clone or download
Pull request Compare This branch is 48 commits ahead of PhilippBaschke:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitignore
.travis.yml
LICENSE
README.md
composer.json
phpunit.xml.dist
travis.php.ini

README.md

ACF PRO Installer

PackagistPackagistBuild Status Dependabot Coverage Status

A composer plugin that makes installing ACF PRO with composer easier.

It reads your 🔑 ACF PRO key from the environment or a .env file.

Usage

1. Add our Advanced Custom Fields Composer Bridge repository to the repositories field in composer.json

This repository simply provides a periodically updated packages.json, that redirects composer to the ACF provided downloads. Note that this repository does not provide any Advanced Custom Fields Pro packages itself, it only tells Composer where it can find ACF Pro packages. Secondly it is important to note that your license key is not submitted to the repository, since the installer downloads the Advanced Custom Fields Pro zip files directly from ACF's servers.

Why this repository?

Since it enables you to use advanced-custom-fields/advanced-custom-fields-pro package with version constraints like any normal Packagist package. You no longer have to update the version manually as you had to with philippbaschke/acf-pro-installer (and tools like dependabot will also work for ACF).

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

This installs the package as wpackagist-plugin type, in case you want a different type, use the following URL:

wordpress-muplugin:

https://pivvenit.github.io/acf-composer-bridge/composer/v2/wordpress-muplugin/

wordpress-plugin:

https://pivvenit.github.io/acf-composer-bridge/composer/v2/wordpress-plugin/

library:

https://pivvenit.github.io/acf-composer-bridge/composer/v2/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

composer require advanced-custom-fields/advanced-custom-fields-pro
You can’t perform that action at this time.