{"id":15684626,"url":"https://github.com/varunsridharan/vsp-framework","last_synced_at":"2025-04-30T08:22:03.821Z","repository":{"id":44740970,"uuid":"109459221","full_name":"varunsridharan/vsp-framework","owner":"varunsridharan","description":"Simple \u0026 Lightweight WP Plugin Framework","archived":false,"fork":false,"pushed_at":"2022-12-08T05:49:28.000Z","size":3782,"stargazers_count":10,"open_issues_count":25,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T14:21:53.506Z","etag":null,"topics":["framework","php","php-framework","vsp-framework","wordpress-development","wordpress-framework","wordpress-library","wordpress-php-library","wordpress-plugin-development","wordpress-plugin-library","wordpress-theme-development","wordpress-theme-library","wordpress-utility","wp-plugin","wp-theme"],"latest_commit_sha":null,"homepage":"https://varunsridharan.github.io/vsp-framework/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/varunsridharan.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"varunsridharan23","patreon":"varunsridharan","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"https://paypal.me/varunsridharan23"}},"created_at":"2017-11-04T02:03:52.000Z","updated_at":"2023-11-07T19:24:48.000Z","dependencies_parsed_at":"2023-01-24T13:15:51.557Z","dependency_job_id":null,"html_url":"https://github.com/varunsridharan/vsp-framework","commit_stats":null,"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Fvsp-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Fvsp-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Fvsp-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Fvsp-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/varunsridharan","download_url":"https://codeload.github.com/varunsridharan/vsp-framework/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251666683,"owners_count":21624353,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework","php","php-framework","vsp-framework","wordpress-development","wordpress-framework","wordpress-library","wordpress-php-library","wordpress-plugin-development","wordpress-plugin-library","wordpress-theme-development","wordpress-theme-library","wordpress-utility","wp-plugin","wp-theme"],"created_at":"2024-10-03T17:20:14.703Z","updated_at":"2025-04-30T08:22:03.795Z","avatar_url":"https://github.com/varunsridharan.png","language":"PHP","funding_links":["https://github.com/sponsors/varunsridharan23","https://patreon.com/varunsridharan","https://paypal.me/varunsridharan23"],"categories":[],"sub_categories":[],"readme":"# VSP Framework\nSimple \u0026 Lightweight WP Plugin Framework\n\n## Installation\nThe preferred way to install this extension is through [Composer](http://getcomposer.org/download/).\n\nTo install **VSP_Framework library**, simply:\n\n    $ composer require varunsridharan/vsp-framework\n\nThe previous command will only install the necessary files, if you prefer to **download the entire source code** you can use:\n\n    $ composer require varunsridharan/vsp-framework --prefer-source\n\nYou can also **clone the complete repository** with Git:\n\n    $ git clone https://github.com/varunsridharan/vsp-framework.git\n\nOr **install it manually**:\n\n[Download VSP_Framework.zip](https://github.com/varunsridharan/vsp-framework/archive/master.zip):\n\n    $ wget https://github.com/varunsridharan/vsp-framework/archive/master.zip\n\n## Usage\n```php\nrequire __DIR__ . '/vsp-framework/vsp-init.php\n\n```\n\n\n## Included Libs / Frameworks\n```json\n{\n    \"require\" : {\n        \"wpbp/pointerplus\"                      : \"dev-master\",\n        \"varunsridharan/wpallimport_rapidaddon\" : \"dev-master\",\n        \"varunsridharan/wp-ajaxer\"              : \"^1.0\",\n        \"varunsridharan/wp-endpoint\"            : \"^1.0\",\n        \"varunsridharan/wp-post\"                : \"^1.0\",\n        \"varunsridharan/wp-review-me\"           : \"^1.0\",\n        \"varunsridharan/wp-transient-api\"       : \"^1.0\",\n        \"varunsridharan/php-autoloader\"         : \"^1.0\",\n        \"varunsridharan/wp-db-table\"            : \"dev-master\",\n        \"a5hleyrich/wp-background-processing\"   : \"^1.0.1\"\n    }\n}\n```\n\n## Configs\n```php\n$config = array();\n```\n\n### Addons Module.\n```php\n/**\n * Plugin's Addon Module Configuration.\n * Config Options\n * array(\n *    'base_path'               =\u003e '',\n *    'base_url'                =\u003e '',\n *    'addon_listing_tab_name'  =\u003e 'addons',\n *    'addon_listing_tab_title' =\u003e 'Addons',\n *    'addon_listing_tab_icon'  =\u003e 'fa fa-plus',\n *    'file_headers'            =\u003e array(),\n *    'show_category_count'     =\u003e true,\n * )\n */\n$config['addons'] = true;\n```\n### Settings / WPOnion Module\n```php\n/**\n * Settings Page Configuration.\n * Below arguments are related to WPOnion.\n * please refer https://github.com/wponion/wponion | https://docs.wponion.com for options informations.\n * basic required ars\n * array(\n *    'option_name' =\u003e '',\n *    'theme' =\u003e 'modern', #modern|fresh|your-theme\n * )\n *\n */\n$config['settings_page'] = array(\n    'option_name'     =\u003e 'vsp_sample_settings',\n    'theme'           =\u003e 'modern',\n    'menu'            =\u003e array(\n        'menu_title' =\u003e __( 'VSP Sample' ),\n        'page_title' =\u003e __( 'VSP Sample Plugin' ),\n        'submenu'    =\u003e true,\n    ),\n    'framework_title' =\u003e __( 'Settings Page' ),\n);\n```\n\n### System Tool Module\n```php\n/**\n * Config for system tools.\n * Possible Values : true / false / array()\n * array(\n *    'system_tools_menu' =\u003e true, # true/false/array of values\n *    'menu'              =\u003e true, # true/false\n *    'system_status'     =\u003e true, #true/false/array of values\n *    'logging'           =\u003e true, #true/false/array of values\n * )\n *\n * system_status /logging / system_tool_menu array data can be like below\n * array(\n *    'name' =\u003e '',\n *    'title' =\u003e '',\n *    'icon'=\u003e''\n * )\n * The above array is related to WPOnion Page Argument.\n *\n * $config['system_tools'] = true;\n * $config['system_tools'] = false;\n * $config['system_tools'] = array(\n *    'menu' =\u003e array(\n *        'title' =\u003e __( 'Sys Tools' ),\n *    ),\n * );\n *\n */\n$config['system_tools'] = true;\n```\n\n### WP Review Me Module\n```php\n/**\n * Custom Lib To popup a alert after x number of days to ask for plugin review.\n * please refer https://github.com/varunsridharan/wp-review-me for options informations.\n */\n$config['VS_WP_Review_Me'] = true;\n```\n\n### Logging Module\n```php\n/**\n * Config to enable logging option.\n * if set to true. then it create a custom logger instance and saves it.\n */\n$config['logging'] = true;\n```\n\n### Autoloader Module\n```php\n/**\n * Config To enable Autoloader PHP Lib\n *\n * @uses \\Varunsridharan\\PHP\\Autoloader https://github.com/varunsridharan/php-autoloader\n *\n * array(\n *    'namespace' =\u003e 'somename',\n *    'basepath' =\u003e __DIR__.'/includes/',\n *    'remaps' =\u003e array(),\n *    'prepend'=\u003e false,\n * )\n */\n$config['autoloader'] = array(\n    'namespace' =\u003e '\\MyPlugin\\Admin',\n    'basepath'  =\u003e __DIR__ . '/includes/admin/',\n);\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarunsridharan%2Fvsp-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvarunsridharan%2Fvsp-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarunsridharan%2Fvsp-framework/lists"}