WordPress Plugin Boilerplate

The WordPress Plugin Boilerplate serves as a foundation off of which to build your WordPress plugins.

Features

The Plugin Boilerplate is fully-based on the WordPress Plugin API
Uses PHPDoc conventions for easily following the code
Liberal use of TODO to guide you through what you need to change
Uses a strict file organization scheme to make sure the assets are easily maintainable

Usage

The WordPress Plugin Boilerplate is ready to activate as-is (though it includes no real functionality).

Copy the plugin-boilerplate directory into your wp-content/plugins directory
Navigate to the “Plugins” dashboard page
Locate the menu item that reads “TODO”
Click on “Activate”

This will activate the WordPress Plugin Boilerplate. Because the Boilerplate has no real functionality, nothing will be added to WordPress; however, this demonstrates exactly how your plugin should behave as you’re working with it.

License

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

Changelog

1.0 (29 November 2012)

Official Release

Author Information

The WordPress Plugin Boilerplate was originally started and is maintained by Tom McFarlin.
The project is open-source and receives contributions from awesome WordPress Developers throughout the world.