inretio
/
WordPress-Plugin-Boilerplate
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
Code Issues Releases Wiki Activity
60 Commits 2 Branches 15 Tags 959 KiB
PHP 92.6%
JavaScript 6.6%
CSS 0.8%
Go to file
Tom McFarlin 1a616eeb65 improving documentation 2013-05-07 22:42:30 -04:00
plugin-boilerplate improving documentation 2013-05-07 22:42:30 -04:00
.gitignore Improved gitignore based on h5bp 2011-11-25 20:10:38 -05:00
README.md Update README.md 2012-11-29 21:46:13 -05:00

README.md

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).

  1. Copy the plugin-boilerplate directory into your wp-content/plugins directory
  2. Navigate to the "Plugins" dashboard page
  3. Locate the menu item that reads "TODO"
  4. 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.