Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nirjharlo/wp-plugin-framework
A WordPress plugin framework.
https://github.com/nirjharlo/wp-plugin-framework
ajax metaboxes shortcode widget wordpress wordpress-boilerplate wordpress-development wordpress-framework wordpress-plugin wordpress-plugin-boilerplate wordpress-plugin-development wp-plugin
Last synced: 3 months ago
JSON representation
A WordPress plugin framework.
- Host: GitHub
- URL: https://github.com/nirjharlo/wp-plugin-framework
- Owner: nirjharlo
- License: gpl-2.0
- Created: 2017-03-20T13:29:14.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T01:40:31.000Z (almost 3 years ago)
- Last Synced: 2024-09-27T14:42:50.355Z (3 months ago)
- Topics: ajax, metaboxes, shortcode, widget, wordpress, wordpress-boilerplate, wordpress-development, wordpress-framework, wordpress-plugin, wordpress-plugin-boilerplate, wordpress-plugin-development, wp-plugin
- Language: PHP
- Homepage:
- Size: 1.56 MB
- Stars: 11
- Watchers: 0
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WP Plugin Framework
[](https://travis-ci.org/nirjharlo/wp-plugin-framework)
[](https://scrutinizer-ci.com/g/nirjharlo/wp-plugin-framework/)
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.
There are extra classes for API integration, AJAX, File upload and Cron jobs.
NOTE: Requires PHP 5.4 and up. Uses `cURL` for API integration class.
## Installation
1. For production environment:
```
composer install --no-dev
```
2. 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.
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.
3. In `plugin/PluginLoader.php` the installation and uninstallation classes contain possible situations, including DB installation and uninstallation features.
## 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.
### `/plugin/lib` Files
`/plugin/lib/Cron.php` :: `Cron` to schedule operations.
`/plugin/lib/Api.php` :: `Api` to integrate 3rd party APIs.
`/plugin/lib/Table.php` :: `Table` to display data tables.
`/plugin/lib/Ajax.php` :: `Ajax` to make AJAX requests.
`/plugin/lib/Upload.php` :: `Upload` to upload a file.
`/plugin/lib/Script.php` :: `Script` to add required CSS and JS.
### `/plugin/src` Files
`/plugin/src/Install.php` :: `Install` to handle activation process.
`/plugin/src/Db.php` :: `Db` to install database tables.
`/plugin/src/Settings.php` :: `Settings` to create admin settings pages.
`/plugin/src/Cpt.php` :: `Cpt` to create custom post type.
`/plugin/src/Widget.php` :: `Widget` to add custom widget.
`/plugin/src/Metabox.php` :: `Metabox` to add custom metabox in editor screen.
`/plugin/src/Shortcode.php`:: `Shortcode` to add and display shortcodes.
`/plugin/src/Query.php`:: `Query` to use post and user query. It uses `wp_pagenavi()` for breadceumbs
`/plugin/src/RestApi.php`:: `RestApi` to extend REST API.