Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/philippbaschke/acf-pro-installer
A composer install helper for Advanced Custom Fields PRO
https://github.com/philippbaschke/acf-pro-installer
acf advanced-custom-fields composer composer-plugin env envfile packagist wordpress wordpress-development wp
Last synced: 6 days ago
JSON representation
A composer install helper for Advanced Custom Fields PRO
- Host: GitHub
- URL: https://github.com/philippbaschke/acf-pro-installer
- Owner: PhilippBaschke
- License: mit
- Created: 2016-04-13T09:44:30.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-02T14:41:36.000Z (over 1 year ago)
- Last Synced: 2025-01-26T17:05:15.283Z (6 days ago)
- Topics: acf, advanced-custom-fields, composer, composer-plugin, env, envfile, packagist, wordpress, wordpress-development, wp
- Language: PHP
- Homepage:
- Size: 38.1 KB
- Stars: 281
- Watchers: 12
- Forks: 70
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ACF PRO Installer
[](https://packagist.org/packages/philippbaschke/acf-pro-installer)
[](https://github.com/PhilippBaschke/acf-pro-installer/blob/master/LICENSE)
[](https://travis-ci.org/PhilippBaschke/acf-pro-installer)
[](https://coveralls.io/github/PhilippBaschke/acf-pro-installer)
A composer plugin that makes installing [ACF PRO] with [composer] easier.
It reads your :key: ACF PRO key from the **environment** or a **.env file**.
[ACF PRO]: https://www.advancedcustomfields.com/pro/
[composer]: https://github.com/composer/composer
## Usage
**1. Add the package repository to the [`repositories`][composer-repositories] field in `composer.json`
(based on this [gist][package-gist]):**
```json
{
"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": {
"philippbaschke/acf-pro-installer": "^1.0",
"composer/installers": "^1.0"
}
}
}
```
Replace `"version": "*.*.*(.*)"` with your desired version.
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.
**2. Make your ACF PRO key available**
Set the environment variable **`ACF_PRO_KEY`** to your [ACF PRO key][acf-account].
Alternatively you can add an entry to your **`.env`** file:
```ini
# .env (same directory as composer.json)
ACF_PRO_KEY=Your-Key-Here
```
**3. Require ACF PRO**
```sh
composer require advanced-custom-fields/advanced-custom-fields-pro:*
```
You can specify an [exact version][composer-versions] (that matches your desired version).
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.
*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][composer-versions].*
[composer-repositories]: https://getcomposer.org/doc/04-schema.md#repositories
[composer-versions]: https://getcomposer.org/doc/articles/versions.md
[package-gist]: https://gist.github.com/fThues/705da4c6574a4441b488
[acf-account]: https://www.advancedcustomfields.com/my-account/