soberwp / bundle
WordPress plugin to enable plugin activation using a JSON, YAML or PHP file.
Installs: 3 943
Dependents: 1
Suggesters: 0
Security: 0
Stars: 25
Watchers: 5
Forks: 3
Open Issues: 0
Type:wordpress-muplugin
Requires
- php: >=5.4.0
- composer/installers: ^1.5
- hassankhan/config: ^1.0
- tgmpa/tgm-plugin-activation: ^2.6.1
Requires (Dev)
This package is auto-updated.
Last update: 2021-06-24 13:02:33 UTC
README
WordPress plugin to enable plugin activation using a JSON, YAML or PHP file.
Installation
Composer:
Recommended method/s;
Roots Bedrock and WP-CLI
$ composer require soberwp/bundle $ wp plugin activate bundle
$ composer require soberwp/bundle:1.0.2-p
Manual:
- Download the zip file
- Unzip to your sites plugin folder
- Activate via WordPress
Requirements:
- PHP >= 5.6.x
Setup
By default either bundle.json
, bundle.yaml
or bundle.php
is used.
You can use a custom file for each using the filters below within your themes functions.php
file;
add_filter('sober/bundle/file', function () { return get_stylesheet_directory() . '/plugin-dependencies.yaml'; });
Usage
Themes often require plugins in order to work — bundle leverages the popular tgmpa class to achieve plugin activation nags and actions.
Examples:
[ { "name": "Disable Comments", "slug": "disable-comments", "required": false, "force_activation": true }, { "name": "Models", "slug": "models", "source": "https://github.com/soberwp/models/archive/master.zip", "external_url": "https://github.com/models/intervention", "required": true, "force_activation": true, "force_deactivation": false } ]
--- - name: Disable Comments slug: disable-comments required: false force_activation: true - name: Models slug: models source: https://github.com/soberwp/models/archive/master.zip external_url: https://github.com/models/intervention required: true force_activation: true force_deactivation: false
<?php return [ [ 'name' => 'Disable Comments', 'slug' => 'disable-comments', 'required' => false, 'force_activation' => true ], [ 'name' => 'Models', 'slug' => 'models', 'source' => 'https://github.com/soberwp/models/archive/master.zip', 'external_url' => 'https://github.com/models/intervention', 'required' => true, 'force_activation' => true, 'force_deactivation' => false ] ];
You can read tgmpa documentation for plugin activation options.
Updates
Composer:
- Change the composer.json version to ^1.0.2**
- Check CHANGELOG.md for any breaking changes before updating.
$ composer update
WordPress:
Includes support for github-updater to keep track on updates through the WordPress backend.
- Download github-updater
- Clone github-updater to your sites plugins/ folder
- Activate via WordPress
Other
- For updates follow @withjacoby
- You can also hire me for WordPress or frontend work