lostcore/lostcore-plugin-boilerplate

LostCore's WordPress Plugin Boilerplate

A standardized, organized, object-oriented foundation for building high-quality WordPress Plugins.

Contents

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 directory that contains the source code.

Features

• Gulp, sass, browserify support. There is a "build task" also included.
• Browserify enforce a more organized and stable structure of the javascript code.
• PSR-4 Support

Installation

The Boilerplate can be installed directly into your plugins folder "as-is". You will want to rename it and the classes inside of it to fit your needs.

Before actual activate the plugin via wordpress you need:

• To rename all occurrences of "PluginName" and "plugin-name". There is also an occurrence of "pluginName" in assets/src/js/main.js.
• Run npm install

Note tha the Boilerplate has no real functionality so no menu items, meta boxes, or custom post types will be added.

ATTENTION: PHP >= 5.4 is required.

Recommended Tools

i18n Tools

The WordPress Plugin Boilerplate 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:

• Poedit
• makepot
• i18n

Any of the above tools should provide you with the proper tooling to internationalize the plugin.

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

A copy of the license is included in the root of the plugin’s directory. The file is named LICENSE.

Important Notes

Licensing

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.

Structure

todo.