README

一个简单的WordPress插件库，用于处理版本管理并提供易于升级的处理。

安装

安装此扩展的首选方式是通过 Composer。

要安装 WP插件版本管理库，只需

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

上述命令只会安装必要的文件，如果您希望 下载整个源代码，则可以使用

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

您还可以使用Git 克隆完整的仓库

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

或者 手动安装

下载WP插件版本管理.zip:

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

参数/选项

`slug`

您插件的唯一键

`版本`

您应传递您插件的版本。

`日志`

如果设置为true，则将其保存更新/安装日志到数据库中

示例日志

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`

自定义数据库键，用于保存您的插件版本和日志。默认情况下，它使用以下方式将所有插件版本存储在数据库中

常见存储示例

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

上述示例存储在 wp_options 表中，使用公共数据库键 _vs_wp_plugin_upgrader

激活用法

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

方法

`version()`

返回当前存储在数据库中的插件版本

`logs()`

返回当前插件的日志

方法用法示例

$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();

📝 更新日志

本项目中所有重要的更改都将记录在此文件中。

格式基于 Keep a Changelog，本项目遵守语义化版本控制。

查看CHANGELOG.md

🤝 贡献

如果您想帮忙，请查看问题列表。

📜 许可证 & 行为准则

📣 反馈

⭐ 如果此项目对您有所帮助！ 😉
如果您需要帮助/发现了一个错误，请创建一个 🔧 问题

💰 赞助商

我于2013年爱上了开源，从那以后就没有回头路了！您可以在这里了解更多关于我的信息。如果您或您的公司使用了我的任何项目或喜欢我所做的事情，请考虑支持我。我会长期坚持下去。

☕ 咖啡时间，我们认识一下？只需 $9.99 就可以为我买一杯咖啡。
☕️☕️ 每个月买我两杯咖啡怎么样？您只需 $9.99。
🔰 我们喜欢改进开源项目。支持一次开源维护1小时，只需 $24.99。
🚀 也喜欢开源工具吗？我也是！只需 一次性的49.99美元 就能支持一小时的开源开发！

连接 & 问候 👋

关注我在 👨‍💻 Github，获取免费和开源软件的最新动态
关注我在 🐦 Twitter，了解我的最新开源项目更新
私信我在 📠 Telegram
关注我的小宠物在 Instagram 上的精彩瞬间！

由 Varun Sridharan 用 ❤️ 构建

varunsridharan / wp-plugin-version-management

维护者

详细信息