pivvenit/acf-pro-installer

A modern maintained install helper for Advanced Custom Fields PRO

Installs: 135 791

Dependents: 1

Suggesters: 0

Security: 0

Stars: 38

Watchers: 2

Forks: 62

Open Issues: 2

Type:composer-plugin

3.0.0 2020-11-21 14:21 UTC

README

PackagistPackagist 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

This plugin is compatible with Both Composer 2.x (latest) and 1.x

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/v3/wordpress-plugin/"
}

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

wordpress-muplugin:

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

wpackagist-plugin:

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

library:

https://pivvenit.github.io/acf-composer-bridge/composer/v3/library/

2. Make your ACF PRO key available

There are 3 ways to make the ACF_PRO_KEY available:

  • Using the ACF_PRO_KEY environment variable
  • .env file
  • Setting acf-pro-key in $COMPOSER_HOME/config.json

Select the one that best matches your setup:

2.a Using the ACF_PRO_KEY Environment variable

Set the environment variable ACF_PRO_KEY to your ACF PRO key.

2.b Use a .env file

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

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

2.c. Setting the key in $COMPOSER_HOME/config.json

You specify the acf-pro-key in the config section of your $COMPOSER_HOME/config.json

{
  "config": {
    "acf-pro-key": "Your-Key-Here"
  }
}

$COMPOSER_HOME is a hidden, global (per-user on the machine) directory that is shared between all projects. By default it points to C:\Users\<user>\AppData\Roaming\Composer on Windows and /Users/\<user\>/.composer on macOS. On *nix systems that follow the XDG Base Directory Specifications, it points to $XDG_CONFIG_HOME/composer. On other *nix systems, it points to /home/\<user\>/.composer.

3. Require ACF PRO

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