nirjharlo/wp-plugin-framework

A framework for quick production of WordPress plugins.

WP Plugin Framework

, _(*1)

A WordPress plugin framework is a simple and light-weight base to build any standard WP plugin on top of it. Easily achieve high productivity. It contains various items, such as Settings pages, Data tables, Widgets, Metaboxes, Custom Post Types, Shortcodes along with infrastructure for DB operations., _(*2)

There are extra classes for API integration, AJAX, File upload and Cron jobs., _(*3)

NOTE: Requires PHP 5.4 and up. Uses cURL for API integration class., _(*4)

Installation

1. For production environment:

composer install --no-dev

1. For development environment:

composer install

./vendor/bin/phpcs --config-set installed_paths ../../wp-coding-standards/wpcs

Usage

1. Change the class namespaces, file namespaces, declarations in wp-plugin-framework.php and install.php before you start coding. Also, change the /asset file paths in plugin file wp-plugin-framework.php to your chosen folder path name. It's a precaution to avoid conflict., _(*5)

2. In plugin/PluginLoader.php the PluginLoader class includes all the files in instance and declares the classes inside them. You can remove existing files or add more files. It's recomended to put all the plugin features instances inside PluginLoader. This will help in organising the code., _(*6)

3. In plugin/PluginLoader.php the installation and uninstallation classes contain possible situations, including DB installation and uninstallation features., _(*7)

Features

Go through the files in /lib/class- and /src/class-. First one contains classes for extra features, while the latter is using essential features., _(*8)

/plugin/lib Files

/plugin/lib/Cron.php :: Cron to schedule operations., _(*9)

/plugin/lib/Api.php :: Api to integrate 3rd party APIs., _(*10)

/plugin/lib/Table.php :: Table to display data tables., _(*11)

/plugin/lib/Ajax.php :: Ajax to make AJAX requests., _(*12)

/plugin/lib/Upload.php :: Upload to upload a file., _(*13)

/plugin/lib/Script.php :: Script to add required CSS and JS., _(*14)

/plugin/src Files

/plugin/src/Install.php :: Install to handle activation process., _(*15)

/plugin/src/Db.php :: Db to install database tables., _(*16)

/plugin/src/Settings.php :: Settings to create admin settings pages., _(*17)

/plugin/src/Cpt.php :: Cpt to create custom post type., _(*18)

/plugin/src/Widget.php :: Widget to add custom widget., _(*19)

/plugin/src/Metabox.php :: Metabox to add custom metabox in editor screen., _(*20)

/plugin/src/Shortcode.php:: Shortcode to add and display shortcodes., _(*21)

/plugin/src/Query.php:: Query to use post and user query. It uses wp_pagenavi() for breadceumbs, _(*22)

/plugin/src/RestApi.php:: RestApi to extend REST API., _(*23)