junaidbhura/composer-wp-pro-plugins

1.8.0 2023-03-14 20:05 UTC

Requires

• composer-plugin-api: ^1.0 || ^2.0
• composer/semver: ^1.0 || ^2.0 || ^3.0
• vlucas/phpdotenv: ^3.0 || ^4.0 || ^5.0

MIT

• Junaid Bhura

README

A Composer plugin that makes it easy to install commercial WordPress plugins.

Sensitive credentials (license keys, tokens) are read from environment variables or a .env file.

Supported Plugins

1. Advanced Custom Fields Pro
2. Ninja Forms Add-Ons
3. Gravity Forms / Add-Ons
4. Polylang Pro
5. PublishPress Pro
6. Advanced Custom Fields Extended Pro
7. WP All Import / Export Pro / Add-Ons
8. WPML

Overview

⚠️ Note: Most EDD plugins, and Gravity Forms, only allow downloading the latest versions of their plugins, even if you request for a specific version.

• Packages must use the names defined below otherwise they are ignored by this plugin.
• When installing or updating a package, the package version is appended to the dist URL. This versioned dist URL is used as the cache key to store ZIP archives of the package. In Composer 1, the versioned dist URL is added to composer.lock.
• Before downloading the package, the package's real download URL is retrieved and formatted with their corresponding environment variables, as defined below. Environment variables will never be stored inside composer.lock.
• If an environment variable can't be resolved, the download will fail and Composer will abort.

Usage

This Composer plugin requires Composer:

• 1.0.0 and newer, or
• 2.0.2 and newer
• 2.3+ IMPORTANT: Make sure to add trailing slashes to packages' dist URL as below. More info: #34

Create a .env file in the root of your WordPress site, where the composer.json file lives, which has all the license keys and settings:

ACF_PRO_KEY="<acf_pro_license_key>"
ACFE_PRO_KEY="<acf_extended_pro_license_key>"
ACFE_PRO_URL="<registered_url_for_acf_extended_pro>"
GRAVITY_FORMS_KEY="<gravity_forms_license_key>"
NINJA_FORMS_KEY="<ninja_forms_membership_license_key>"
NINJA_FORMS_URL="<registered_url_for_ninja_forms_membership>"
NINJA_FORMS_<addon_slug>_KEY="<ninja_forms_addon_license_key>"
NINJA_FORMS_<addon_slug>_URL="<registered_url_for_ninja_forms_addon>"
POLYLANG_PRO_KEY="<polylang_pro_license_key>"
POLYLANG_PRO_URL="<registered_url_for_polylang_pro>"
PUBLISHPRESS_PRO_KEY="<publishpress_pro_membership_license_key>"
PUBLISHPRESS_PRO_URL="<registered_url_for_publishpress_pro_membership>"
PUBLISHPRESS_<plugin_slug>_PRO_KEY="<publishpress_pro_license_key>"
PUBLISHPRESS_<plugin_slug>_PRO_URL="<registered_url_for_publishpress_pro>"
WP_ALL_IMPORT_PRO_KEY="<wp_all_import_license_key>"
WP_ALL_IMPORT_PRO_URL="<registered_url_for_wpai_pro>"
WP_ALL_EXPORT_PRO_KEY="<wp_all_export_license_key>"
WP_ALL_EXPORT_PRO_URL="<registered_url_for_wpae_pro>"
WPML_USER_ID="<wpml_user_id>"
WPML_KEY="<wpml_key>"

Add the following to your composer.json file:

"repositories": [
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/acf-extended-pro",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.acf-extended.com/"
      },
      "require": {
          "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/advanced-custom-fields-pro",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.advancedcustomfields.com/"
      },
      "require": {
          "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/gravityforms",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.gravityforms.com/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/gravityformspolls",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.gravityforms.com/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/ninja-forms-uploads",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://ninjaforms.com/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/polylang-pro",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.polylang.pro/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/publishpress-planner-pro",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://publishpress.com/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/wp-all-import-pro",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.wpallimport.com/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/wp-all-export-pro",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.wpallimport.com/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/wpai-acf-add-on",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.wpallimport.com/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/wpae-acf-add-on",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.wpallimport.com/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/wpae-user-add-on-pro",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://www.wpallimport.com/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/wpml-sitepress-multilingual-cms",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://wpml.org/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  },
  {
    "type": "package",
    "package": {
      "name": "junaidbhura/wpml-string-translation",
      "version": "<version_number>",
      "type": "wordpress-plugin",
      "dist": {
        "type": "zip",
        "url": "https://wpml.org/"
      },
      "require": {
        "junaidbhura/composer-wp-pro-plugins": "*"
      }
    }
  }
],
"require": {
  "junaidbhura/acf-extended-pro": "*",
  "junaidbhura/advanced-custom-fields-pro": "*",
  "junaidbhura/gravityforms": "*",
  "junaidbhura/gravityformspolls": "*",
  "junaidbhura/ninja-forms-uploads": "*",
  "junaidbhura/polylang-pro": "*",
  "junaidbhura/publishpress-planner-pro": "*",
  "junaidbhura/wp-all-import-pro": "*",
  "junaidbhura/wp-all-export-pro": "*",
  "junaidbhura/wpai-acf-add-on": "*",
  "junaidbhura/wpae-acf-add-on": "*",
  "junaidbhura/wpae-user-add-on-pro": "*",
  "junaidbhura/wpml-sitepress-multilingual-cms": "*",
  "junaidbhura/wpml-string-translation": "*"
},

Gravity Forms Add-Ons

You can use any Gravity Forms add-on by simply adding it's slug like so:

junaidbhura/<plugin-slug>

For example:

junaidbhura/gravityformspolls

Here's a list of all Gravity Forms add-on slugs: https://docs.gravityforms.com/gravity-forms-add-on-slugs/

Ninja Forms Add-Ons

You can use any Ninja Forms add-on by simply adding it's slug like so:

junaidbhura/ninja-forms-<addon-slug>

The following add-ons are supported:

PublishPress Pro Plugins

You can use any PublishPress Pro plugins by simply adding it's slug like so:

junaidbhura/<plugin-slug>

The following plugins are supported:

WP All Import Pro Add-Ons

You can use any WP All Import Pro add-on by simply adding it's slug like so:

junaidbhura/<plugin-slug>

For example:

junaidbhura/wpai-acf-add-on

WP All Export Pro Add-Ons

You can use any WP All Export Pro add-on by simply adding it's slug like so:

junaidbhura/<plugin-slug>

For example:

junaidbhura/wpae-acf-add-on

WPML Add-Ons

You can use any WPML add-on by simply adding it's slug like so:

junaidbhura/wpml-<addon-slug>

The following add-ons are supported:

• junaidbhura/wpml-acfml
• junaidbhura/wpml-all-import
• junaidbhura/wpml-buddypress-multilingual
• junaidbhura/wpml-cms-nav
• junaidbhura/wpml-contact-form-7-multilingual
• junaidbhura/wpml-gravityforms-multilingual
• junaidbhura/wpml-mailchimp-for-wp
• junaidbhura/wpml-media-translation
• junaidbhura/wpml-ninja-forms
• junaidbhura/wpml-sticky-links
• junaidbhura/wpml-string-translation
• junaidbhura/wpml-translation-management
• junaidbhura/wpml-types
• junaidbhura/wpml-woocommerce-multilingual
• junaidbhura/wpml-wp-seo-multilingual
• junaidbhura/wpml-wpforms