README

Simple WordPress Plugin Library To Handle Version Management To Provide Easy Upgrade Handling.

Installation

The preferred way to install this extension is through Composer.

To install WP Plugin Version Management library, simply:

$ composer require varunsridharan/wp-plugin-version-management

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require varunsridharan/wp-plugin-version-management --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/varunsridharan/wp-plugin-version-management.git

Or install it manually:

Download WP Plugin Version Management.zip:

$ wget https://github.com/varunsridharan/wp-plugin-version-management/archive/master.zip

Arguments / Options

slug

Unique Key for your plugin

version

You Should Pass your plugins version.

logs

If its set to true then it saves update / install logs in database

Example Log

array(
	'1.0' => array(
		'user_id' => 1, // Stores Current User ID who install / upgrades the plugin
		'time'    => 2999391, // Stores Upgrade As Timestamp using `current_time('timestamp')`
		'from'    => false, // Which Version is upgraded from | false means its a fresh install
	),
	'1.1' => array(
		'user_id' => 1, // Stores Current User ID who install / upgrades the plugin
		'time'    => 3949391, // Stores Upgrade As Timestamp using `current_time('timestamp')`
		'from'    => '1.0', // Which Version is upgraded from | false means its a fresh install
	),
);

option_name

Custom database key on where to save your plugins version and logs. by default it stores all plugins version in database using

Example of Common Storage

array(
	'your-plugin-slug'    => array(
		'version' => '',
		'logs'    => '',
	),
	'another-plugin-slug' => array(
		'version' => '',
		'logs'    => array(),
	),
);

The above example are stored in wp_options table with a common database key _vs_wp_plugin_upgrader

Activation Usage

<?php

register_activation_hook( __FILE__, 'your_plugin_activation' );

if ( ! function_exists( 'your_plugin_install_v1' ) ) {
	function your_plugin_install_v1( $from_version = false, $to_version = false ) {
		// do your stuff.
		return true; // should return something | return true if update is sucess / return false
	}
}

if ( ! function_exists( 'your_plugin_install_v1_1' ) ) {
	function your_plugin_install_v1_1( $from_version = false, $to_version = false ) {
		// do your stuff.
		return true; // should return something | return true if update is sucess / return false
	}
}

if ( ! function_exists( 'your_plugin_activation' ) ) {
	function your_plugin_activation() {
		$upgrader = new Varunsridharan\WordPress\Plugin_Version_Management( array(
			'slug'    => 'your-plugin-slug', // Uniquq Slug For Your Plugin.
			'logs'    => true, // Set True to save upgrade logs.
			'version' => '1.2', // Your Plugins New Version
		), array(
			'1.0' => 'your_plugin_install_v1',
			'1.1' => 'your_plugin_install_v1_1',
		) );

		$upgrader->run(); // Run Function Should Be Called.
	}
}

Methods

version()

Return current plugins version stored in database

logs()

Returns Current Plugins Logs

Method Usage Example

$upgrader = new Varunsridharan\WordPress\Plugin_Version_Management( array(
    'slug'    => 'your-plugin-slug', // Uniquq Slug For Your Plugin.
    'option_name'=> true,// use the same value which is used in register_plugin_activation if not set it to true
));


// Returns Current Version
$upgrader->version();

// Returns Logs
$upgrader->logs();

📝 Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

🤝 Contributing

If you would like to help, please take a look at the list of issues.

📜 License & Conduct

• GNU General Public License v3.0 © Varun Sridharan
• Code of Conduct

📣 Feedback

• ⭐ This repository if this project helped you! 😉
• Create An 🔧 Issue if you need help / found a bug

💰 Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. If you, or your company, use any of my projects or like what I’m doing, kindly consider backing me. I'm in this for the long run.

• ☕ How about we get to know each other over coffee? Buy me a cup for just $9.99
• ☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
• 🔰 We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
• 🚀 Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

Connect & Say 👋

• Follow me on 👨‍💻 Github and stay updated on free and open-source software
• Follow me on 🐦 Twitter to get updates on my latest open source projects
• Message me on 📠 Telegram
• Follow my pet on Instagram for some dog-tastic updates!

Built With ♥ By Varun Sridharan