This project is based on the WordPress Plugin Boilerplate project.
The WordPress Plugin Boilerplate includes the following files:
.gitignore
. Used to exclude certain files from the repository.CHANGELOG.md
. The list of changes to the core project.README.md
. The file that you're currently reading.- A
plugin-name
subdirectory that contains the source code - a fully executable WordPress plugin.
The Boilerplate can be installed in one of two ways both of which are documented below. Note that because of its directory structure, the Boilerplate cannot be installed “as-is.”
Instead, the options are:
- Copy the
trunk
directory into yourwp-content/plugins
directory. You may wish to rename this to something else. - In the WordPress admin area, navigation to the Plugins page Locate the menu item that reads "The WordPress Plugin Boilerplate."
- Click on Activate.
The WordPress Plugin Boilerplate 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
A copy of the license is included in the root of the plugin's directory. The
file is named LICENSE
.
The WordPress Plugin Boilerplate 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.
This simple project is a basically a refactoring of the work created by Tom McFarlin and others: WordPress Plugin Boilerplate.
Because this version is a major rewrite of the core plugin, we're working to create an entire site around the Boilerplate. If you're interested, please let me know and we'll see what we can do.