This is a boilerplate WordPress plugin featuring namespace autoloading and integration with Carbon Fields. It is intended to be used as a starting point for creating WordPress plugins. It contains several examples and dependencies to get you started.
It may also be used as the means of separating custom code from the theme.
Here are some ways that you can contribute:
- Suggest improvements and/or code them.
- Test the translation mechanisms - they have not been extensively tested yet.
- Report bugs and/or incompatibilities
- Namespaces & dependency autoloading
- Version checking (PHP, Carbon Fields)
- Powered by Composer, Gulp and Bower
- Object caching (where available; usage examples)
- Automatic translation file (
.pot) creation. See Translation. - Shortcodes, widgets (via Carbon Fields) and custom post types (via PostTypes) examples
- Configuration registry (docs) and optional
wp-config.phpconstants - More to come...
Note: Gulp and Bower are optional, but handy. If you do not wish to use them, you can delete the references.
- WordPress 4.0 or higher
- PHP 5.6 or higher
- Carbon Fields 2.0 or higher (see the wiki section Carbon Fields for more info).
If you need tips on installing Node.js, Composer, Gulp & Bower, see Installing Dependencies.
- Clone repository to
plugins - Change the four variables in package.json
- Run
npm install; gulp rename; composer install
- At command prompt, change to your
wp-content/pluginsdirectory. - Clone the repository:
git clone https://github.com/dmhendricks/wordpress-base-plugin.git - Renamed the newly created
wordpress-base-plugindirectory to your own plugin slug.
See the Getting Started documentation for further steps.
- Add Customizer example
- Add dynamically-created CSS/JS files based on settings
- Refactor the Plugin class for better organization and self-documentation
- Create decent documentation and perform cleanup on the wordpress-toolkit dependency
- Add phpdotenv support
- Add encrypted text field example
- Add some useful Carbon Fields CSS classes
Release changes are noted on the Releases page.
- None since release
Please support humans.txt. It's an initiative for knowing the people behind a web site. It's an unobtrusive text file that contains information about the different people who have contributed to building the web site.
Carbon Fields
URL: http://carbonfields.net/
Author: htmlBurger.com
Twitter: @htmlburger
Author URI: https://htmlburger.com/
Location: London, England
WPGulp
URL: https://labs.ahmadawais.com/WPGulp/
Author: Ahmad Awais
Twitter: @mrahmadawais
Author URI: https://ahmadawais.com/
Location: Asal, Pakistan
PostTypes
URL: https://github.com/jjgrainger/PostTypes/
Author: Joe Grainger
Twitter: @jjgrainger
Author URI: https://jjgrainger.co.uk/
Location: Falmouth, England
