This boilerplate is designed mainly for simple and light plugins in mind. It is constructed the same as the standard WordPress Plugin Boilerplate only without most of the features. It's a developer friendly environment that allows you to get a head start with the ground work for any plugin. Included with the boilerplate you also have actions and filter hooks in place that not only make it easy for you to create extensions for your plugin but for third-party developers as well.
Documentation will be available soon on BoilWP.com. In the mean time you can use the support board to ask questions.
- Ready to build on and is third-party ready for other developers to build add-ons for your plugin.
- Custom settings page separated via tabs and sections.
- Help Tabs on all the plugin pages ready and prepared.
The WordPress Plugin Boilerplate includes the following files:
- This README.md
- CHANGELOG.md
- CONTRIBUTING.md
- license.txt file
.editorconfigfile..gitattributesfile..gitignorefile..jshintrcfile..travis.ymlfile..composer.jsonfile.Gruntfile.jsfile.package.jsonfile- A subdirectory called
wordpress-plugin-boilerplate-lightthat represents the core plugin file.
- Copy the
wordpress-plugin-boilerplate-lightdirectory into yourwp-content/pluginsdirectory - Navigate to the Plugins dashboard page
- Locate 'WordPress Plugin Boilerplate Light'
- Click on Activate
This will activate "WordPress Plugin Boilerplate Light" and I recommend that you install it on a development site not a live site.
The WordPress Plugin Boilerplate Light uses a variable to store the text domain used when internationalizing strings throughout the Boilerplate. To take advantage of this method, there are tools that are recommended for providing correct, translatable files:
Any of the above tools should provide you with the proper tooling to localize the plugin.
The WordPress Plugin Boilerplate Light includes native support for the GitHub Updater which allows you to provide updates to your WordPress plugin from GitHub.
This uses a new tag in the plugin header:
* GitHub Plugin URI: https://github.com/<owner>/<repo>
Here's how to take advantage of this feature:
- Install the GitHub Updater
- Replace the url of the repository for your plugin
- Push commits to the master branch
- Enjoy your plugin being updated in the WordPress dashboard
The current version of the GitHub Updater supports tags/branches - whichever has the highest number.
To specify a branch that you would like to use for updating, just add a GitHub Branch: header. GitHub Updater will preferentially use a tag over a branch having the same or lesser version number. If the version number of the specified branch is greater then the update will pull from the branch and not from the tag.
The default state is either GitHub Branch: master or nothing at all. They are equivalent.
All that info is in the project.
This repository is not suitable for support. Please don't use the issue tracker for support requests, but for core WordPress Plugin Boilerplate Light issues only. Support can take place in the appropriate channel:
- The support board at BoilWP.com, where the community can help each other out.
Support requests in issues on this repository will be closed on sight.
If you have a patch, or stumbled upon an issue with WordPress Plugin Boilerplate Light core, you can contribute this back to the code. Please read the contributor guidelines for more information how you can do this.
The WordPress Plugin Boilerplate Light is licensed under the GPL v2 or later.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
The WordPress Plugin Boilerplate Light is licensed under the GPL v2 or later; however, if you opt to use third-party code that is not compatible with v2, then you may need to switch to using code that is GPL v3 compatible.
For reference, here's a discussion that covers the Apache 2.0 License used by Bootstrap.