Download the PHP package oblak/wp-plugin-installer without Composer
On this page you can find all versions of the php package oblak/wp-plugin-installer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download oblak/wp-plugin-installer
More information about oblak/wp-plugin-installer
Files in oblak/wp-plugin-installer
Package wp-plugin-installer
Short Description Simplifies the installation and activation of WordPress plugins
License GPL-2.0-only
Informations about the package wp-plugin-installer
📦 WordPress plugin installer / activator
Simplifies the installation and activation of WordPress plugins.
![Packagist Version](https://img.shields.io/packagist/v/oblak/wp-plugin-installer)
![Packagist PHP Version](https://img.shields.io/packagist/dependency-v/oblak/wp-plugin-installer/php)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/oblakstudio/wp-plugin-installer)
[![Release](https://github.com/oblakstudio/wp-plugin-installer/actions/workflows/release.yml/badge.svg)](https://github.com/oblakstudio/wp-plugin-installer/actions/workflows/release.yml)
![GitHub](https://img.shields.io/github/license/oblakstudio/wp-plugin-installer)
![Packagist Downloads](https://img.shields.io/packagist/dm/oblak/wp-plugin-installer)
Highlights
- Based on WooCommerce installation and activation process.
- Automatically updates plugin and database schema versions.
- Handles database table creation and updates (Schema enforcement).
- Provides WP-CLI commands for manual updates, and database table creation / verification.
- Easily extendable
Installation
We officially support installing via composer only
Via composer
Basic Usage
Base_Plugin_Installer
is an abstract singleton class which can be extended to create a plugin installer class. The class is responsible for installing and activating the plugin, and updating the plugin and database schema versions.
You need to extend it and implement the set_defaults()
method, which is responsible for setting the default values for the class.
If your plugin needs non-wp database tables, you need to implement the get_schema()
method, and set the has_db_tables
property to true
, so that the installer can create and update the tables.
Class depends on Action Scheduler for running update callbacks in the background. If your plugin uses Action Scheduler, or depends on an another plugin, which has Action Scheduler, you can skip the activation step.
1. Define your installer class
2. Action Scheduler activation
3. Include the autoload file
4. Instantiate the installer class
Advanced Usage
Covered in the documentation.
Contributing
Contributions are welcome from everyone. We have contributing guidelines to help you get started.
Credits and special thanks
This project is maintained by Oblak Studio.
Special thanks goes to good people at Automattic for creating WooCommerce on whose installer this one is based upon, and Action Scheduler, which enables us to run update callbacks in the background.
License
This project is licensed under the GNU General Public License v2.0.
All versions of wp-plugin-installer with dependencies
automattic/jetpack-constants Version ^2
woocommerce/action-scheduler Version ^3.7
x-wp/admin-notice-manager Version ^1.0