soberwp/bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

WordPress plugin to enable plugin activation using a JSON, YAML or PHP file.

Maintainers

Details

github.com/soberwp/bundle

Homepage

Source

Issues

Installs: 3 869

Dependents: 1

Suggesters: 0

Security: 0

Stars: 25

Watchers: 5

Forks: 3

Open Issues: 0

Type:wordpress-muplugin

1.0.2-p 2018-08-21 08:33 UTC

Requires

Requires (Dev)

MIT 3fa1c7de248b959f04d82dd5ea2f156f524f045e

wordpress

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

Roots Sage

$ composer require soberwp/bundle:1.0.2-p

Manual:

  • Download the zip file
  • Unzip to your sites plugin folder
  • Activate via WordPress

Requirements:

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:

bundle.json

[
  {
    "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
  }
]

bundle.yaml

---
- 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

bundle.php

<?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.

Other