There are probably more plugin boilerplates than actual plugins available for bootstrapping your work on an amazing WordPress plugin. And that is very much okay, because every developer, every agency has their own little flavors in how they like to do things.
That is the reason we made this plugin boilerplate. We liked the work of so many other developers before us, but we never found the perfect boilerplate that fit our style of work. The result is this, a very opinionated plugin boilerplate based on docker, grunt and less-css.
This boilerplate will give you all the tools you need to write, test and publish your plugin, either for commercial clients or to publish the plugin in the WordPress.org repository.
These steps will guide you through the setup process up until you can start writing functions, markup and styles for your plugin.
For the sake of scope we will assume that you know the slug of your plugin. Please make sure that the slug is unique to the system of the client, our projects and the WordPress.org plugin repository.
We will also assume, that you have already configured your GitHub repository to your liking, downloaded the source of the boilerplate and uploaded it to your new repository. So let's get started:
- Search & Replace (case sensitive)
lhpbpwith your new WordPress plugin slug - Search & Replace (case sensitive)
_LHPBPwith your new WordPress plugin slug in uppercase - Check success in
package.json - Adjust
nameinpackage.json
- Type
npm startinto the terminal to spin up the docker enviroment - Open
http://localhost/wp-adminand log in withadmin:password
- Create a patch release with the github action
- Check if the release has been created and uploaded in the GitHub release section
- Edit the
plugin-README.mdwith the appropriate text about your plugin - Delete (or rename) the
README.md(this file) - Rename the
plugin-README.mdtoREADME.md - 🎉 Celebrate!