varunsridharan / vsp-framework
Simple & Lightweight WP Plugin Framework
Fund package maintenance!
varunsridharan23
Patreon
paypal.me/varunsridharan23
Installs: 510
Dependents: 0
Suggesters: 0
Security: 0
Stars: 10
Watchers: 2
Forks: 2
Open Issues: 25
Requires
- varunsridharan/sweetalert2-php: >=1.0
- varunsridharan/wp-ajaxer: >=1.0
- varunsridharan/wp-db-table: >=1.2.1
- varunsridharan/wp-localizer: >=1.0
- varunsridharan/wp-plugin-version-management: >=1.0
- varunsridharan/wp-post: >=1.0
- varunsridharan/wp-transient-api: >=1.0
- varunsridharan/wpallimport_rapidaddon: *
- wponion/wponion: *
Requires (Dev)
- dev-master
- 0.8.9.8
- 0.8.9.7
- 0.8.9.6
- 0.8.9.5
- 0.8.9.4
- 0.8.9.3
- 0.8.9.2
- 0.8.9.1
- 0.8.9
- 0.8.8
- 0.8.7
- 0.8.6
- 0.8.5
- 0.8.4
- 0.8.3
- 0.8.2
- 0.8.0
- 0.7.9
- 0.7.8
- 0.7.7
- 0.7.6
- 0.7.5
- 0.7.4
- 0.7.3
- 0.7.2
- 0.7.1
- 0.7
- 0.6
- 0.1.5.10
- 0.1.5.9
- 0.1.5.8
- 0.1.5.7
- 0.1.5.6
- 0.1.5.5
- 0.1.5.4
- 0.1.5.3
- 0.1.5.2
- 0.1.5.1
- 0.1.5
- 0.1.4.5
- 0.1.4.4
- 0.1.4.3
- 0.1.4.2
- 0.1.4.1
- 0.1.4
- 0.1.3
- 0.1.1
- 0.1
- dev-dependabot/npm_and_yarn/qs-6.5.3
- dev-dependabot/npm_and_yarn/decode-uri-component-0.2.2
- dev-dependabot/npm_and_yarn/loader-utils-1.4.2
- dev-dependabot/npm_and_yarn/minimatch-and-gulp-combine-files-3.0.4
- dev-dependabot/npm_and_yarn/copy-props-2.0.5
- dev-dependabot/npm_and_yarn/ajv-6.12.6
- dev-dependabot/npm_and_yarn/node-sass-7.0.0
- dev-dependabot/composer/mustache/mustache-2.14.1
- dev-dependabot/npm_and_yarn/path-parse-1.0.7
- dev-dependabot/npm_and_yarn/postcss-7.0.36
- dev-dependabot/composer/rmccue/requests-1.8.1
- dev-dependabot/npm_and_yarn/browserslist-4.16.6
- dev-dependabot/composer/wp-cli/wp-cli-2.5.0
- dev-dependabot/npm_and_yarn/hosted-git-info-2.8.9
- dev-dependabot/add-v2-config-file
- dev-dependabot/npm_and_yarn/ssri-6.0.2
- dev-dependabot/composer/varunsridharan/wp-transient-api-1.8
- dev-dependabot/composer/varunsridharan/wp-post-1.6
- dev-dependabot/composer/varunsridharan/wp-plugin-version-management-1.3
- dev-dependabot/composer/varunsridharan/wp-localizer-1.2
- dev-dependabot/composer/varunsridharan/wp-db-table-1.5
- dev-dependabot/composer/varunsridharan/sweetalert2-php-1.0.6
- dev-dependabot/npm_and_yarn/y18n-3.2.2
- dev-dependabot/composer/wponion/wponion-1.5.3.7
- dev-dependabot/npm_and_yarn/elliptic-6.5.4
This package is auto-updated.
Last update: 2024-10-30 01:48:21 UTC
README
Simple & Lightweight WP Plugin Framework
Installation
The preferred way to install this extension is through Composer.
To install VSP_Framework library, simply:
$ composer require varunsridharan/vsp-framework
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
$ composer require varunsridharan/vsp-framework --prefer-source
You can also clone the complete repository with Git:
$ git clone https://github.com/varunsridharan/vsp-framework.git
Or install it manually:
$ wget https://github.com/varunsridharan/vsp-framework/archive/master.zip
Usage
require __DIR__ . '/vsp-framework/vsp-init.php
Included Libs / Frameworks
{ "require" : { "wpbp/pointerplus" : "dev-master", "varunsridharan/wpallimport_rapidaddon" : "dev-master", "varunsridharan/wp-ajaxer" : "^1.0", "varunsridharan/wp-endpoint" : "^1.0", "varunsridharan/wp-post" : "^1.0", "varunsridharan/wp-review-me" : "^1.0", "varunsridharan/wp-transient-api" : "^1.0", "varunsridharan/php-autoloader" : "^1.0", "varunsridharan/wp-db-table" : "dev-master", "a5hleyrich/wp-background-processing" : "^1.0.1" } }
Configs
$config = array();
Addons Module.
/** * Plugin's Addon Module Configuration. * Config Options * array( * 'base_path' => '', * 'base_url' => '', * 'addon_listing_tab_name' => 'addons', * 'addon_listing_tab_title' => 'Addons', * 'addon_listing_tab_icon' => 'fa fa-plus', * 'file_headers' => array(), * 'show_category_count' => true, * ) */ $config['addons'] = true;
Settings / WPOnion Module
/** * Settings Page Configuration. * Below arguments are related to WPOnion. * please refer https://github.com/wponion/wponion | https://docs.wponion.com for options informations. * basic required ars * array( * 'option_name' => '', * 'theme' => 'modern', #modern|fresh|your-theme * ) * */ $config['settings_page'] = array( 'option_name' => 'vsp_sample_settings', 'theme' => 'modern', 'menu' => array( 'menu_title' => __( 'VSP Sample' ), 'page_title' => __( 'VSP Sample Plugin' ), 'submenu' => true, ), 'framework_title' => __( 'Settings Page' ), );
System Tool Module
/** * Config for system tools. * Possible Values : true / false / array() * array( * 'system_tools_menu' => true, # true/false/array of values * 'menu' => true, # true/false * 'system_status' => true, #true/false/array of values * 'logging' => true, #true/false/array of values * ) * * system_status /logging / system_tool_menu array data can be like below * array( * 'name' => '', * 'title' => '', * 'icon'=>'' * ) * The above array is related to WPOnion Page Argument. * * $config['system_tools'] = true; * $config['system_tools'] = false; * $config['system_tools'] = array( * 'menu' => array( * 'title' => __( 'Sys Tools' ), * ), * ); * */ $config['system_tools'] = true;
WP Review Me Module
/** * Custom Lib To popup a alert after x number of days to ask for plugin review. * please refer https://github.com/varunsridharan/wp-review-me for options informations. */ $config['VS_WP_Review_Me'] = true;
Logging Module
/** * Config to enable logging option. * if set to true. then it create a custom logger instance and saves it. */ $config['logging'] = true;
Autoloader Module
/** * Config To enable Autoloader PHP Lib * * @uses \Varunsridharan\PHP\Autoloader https://github.com/varunsridharan/php-autoloader * * array( * 'namespace' => 'somename', * 'basepath' => __DIR__.'/includes/', * 'remaps' => array(), * 'prepend'=> false, * ) */ $config['autoloader'] = array( 'namespace' => '\MyPlugin\Admin', 'basepath' => __DIR__ . '/includes/admin/', );