szepeviktor / composer-envato
Composer plugin for Envato
Installs: 7 226
Dependents: 1
Suggesters: 0
Security: 0
Stars: 33
Watchers: 4
Forks: 4
Open Issues: 1
Type:composer-plugin
Requires
- php: ^7.4 || ^8.0
- composer-plugin-api: ^2.0
- composer/installers: ^1.10 || ^2.0
- vlucas/phpdotenv: ^4.3 || ^5.5
Requires (Dev)
- composer/composer: ^2.3.0
- phpstan/phpstan: ^1.9
Suggests
- szepeviktor/composer-theme-fusion: Composer plugin for ThemeFusion
README
A Composer plugin to load WordPress themes and plugins from Envato.
💡 Always the latest version is installed, as Envato does not make other versions available. Package version locking can only be achieved by local persistent cache, not across hosts or users.
Installation
This Composer plugin adds a virtual package repository.
It is recommended to install it globally:
composer global require --update-no-dev szepeviktor/composer-envato
It can also be installed per-project:
composer require --update-no-dev szepeviktor/composer-envato
Configuration
Add all your Envato products as "packages" in either the local composer.json
file or the global config.json
file (located in $COMPOSER_HOME
).
You can find the item-id
at the end of product URL-s.
e.g. https://themeforest.net/item/avada-responsive-multipurpose-theme/2833226
{ "config": { "envato": { "token": "YOUR ENVATO PERSONAL TOKEN FROM https://build.envato.com/create-token", "packages": { "envato/avada-theme": { "item-id": 2833226, "type": "wordpress-theme" }, "envato/layerslider-plugin": { "item-id": 1362246, "type": "wordpress-plugin" } } } } }
💡 Please use the vendor name envato
for consistency.
The personal token can also be read from an environment variable or a .env
file.
Create a .env
file, where the composer.json
file lives, and add the following:
ENVATO_TOKEN="<YOUR ENVATO PERSONAL TOKEN FROM https://build.envato.com/create-token>"
Usage
Once the plugin is installed and configured, you can simply install any of the listed products as Composer packages.
💡 Envato API has dynamic rate limiting
Behind the scenes
- This package is a Composer plugin
- In the
activate
method it creates anArrayRepository
with package data fromconfig.json
- Package version is queried from Envato API
- When installing a package its URL is also queried from Envato API
- Pretty package version is e.g.
v1.2
- Normalized package version is e.g.
1.2.0.0