• Documentation
• Features
• Requirements
• Installation
• Future Goals
• Change Log

This is a boilerplate WordPress plugin featuring namespace autoloading and Carbon Fields examples. 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 or extending a child 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)
• Easy installable ZIP file generation: npm run zip
• Automatic translation file (.pot) creation. See Translation.
• Network Admin (multisite) options, shortcodes, widgets (via Carbon Fields) and custom post types (via PostTypes) examples
• Configuration registry (docs) and optional wp-config.php constants
• Customizer options
• Define environmental variables via .env files (reference)
• 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.7 or higher
• PHP 5.6 or higher
• Carbon Fields 2.0 or higher (2.2 or higher for multisite example; see the wiki section Carbon Fields for more info).

If you need tips on installing Node.js, Composer, Gulp & Bower, see Installing Dependencies.

1. Clone repository to your plugins directory
2. Change the four variables in package.json. Modify plugin.json as necessary.
3. Run npm install; gulp rename; composer install
4. (optional) For some of the included examples to work, you'll also want to run: bower install; gulp;

1. At command prompt, change to your wp-content/plugins directory.
2. Clone the repository: git clone https://github.com/dmhendricks/wordpress-base-plugin.git
3. Renamed the newly created wordpress-base-plugin directory to your own plugin slug.

See the Getting Started documentation for further steps.

• Add plugin uninstall support
• Add support for Gulp 4.0
• Switch to npm and WebPack for frontend dependency management

Release changes are noted on the Releases page.

• None since release