iff-studio/acf-pro-installer

An install helper for Advanced Custom Fields PRO. Forked from https://github.com/PhilippBaschke/acf-pro-installer

This is fork

This is fork of https://github.com/PhilippBaschke/acf-pro-installer, _(*1)

Due to issues braking builds I had to fork project and apply community fixes. I intend to stop adding fixes to this project as soon as original author will include community patches., _(*2)

Thanks Philipp Baschke for developing this amazing library as it saved loads of developers hours of work., _(*3)

ACF PRO Installer

, _(*4)

A composer plugin that makes installing ACF PRO with composer easier., _(*5)

It reads your :key: ACF PRO key from the environment or a .env file., _(*6)

Usage

1. Add the package repository to the repositories field in composer.json (based on this gist):, _(*7)

{
  "type": "package",
  "package": {
    "name": "advanced-custom-fields/advanced-custom-fields-pro",
    "version": "*.*.*(.*)",
    "type": "wordpress-plugin",
    "dist": {
      "type": "zip",
      "url": "https://connect.advancedcustomfields.com/index.php?p=pro&a=download"
    },
    "require": {
      "iff-studio/acf-pro-installer": "^1.0",
      "composer/installers": "^1.0"
    }
  }
}

Replace "version": "*.*.*(.*)" with your desired version., _(*8)

Replace "type": "wordpress-plugin" with "type": "library" if you would like to have ACF PRO installed in the ./vendor directory instead of ./wp-content/plugins. This may be desireable if for example, you are including ACF PRO in a WordPress theme., _(*9)

2. Make your ACF PRO key available, _(*10)

Set the environment variable ACF_PRO_KEY to your ACF PRO key., _(*11)

Alternatively you can add an entry to your .env file:, _(*12)

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

3. Require ACF PRO, _(*13)

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

You can specify an exact version (that matches your desired version)., _(*14)

If you use *, composer will install the version from the package repository (see 1). This has the benefit that you only need to change the version in the package repository when you want to update., _(*15)

Be aware that composer update will only work if you change the version in the package repository. Decreasing the version only works if you require an exact version., _(*16)