A starter template for WordPress plugins, with autoloading, namespaces and object caching (where available).
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Fix prefix issue with multiple installs Oct 28, 2018
assets Updated screenshot Jan 16, 2018
languages Minor cleanup Aug 17, 2017
src Added additional rename variables Jan 22, 2018
.bowerrc
.editorconfig
.gitignore Added .env to ignore list Jan 23, 2018
LICENSE Initial commit Dec 27, 2016
README.md Minor copy changes Nov 16, 2018
bower.json
composer.json Fix prefix issue with multiple installs Oct 28, 2018
gulpfile.js Upgraded Gulp to 4.0 Sep 26, 2018
package.json Bumped wp-pot CLI version Oct 20, 2018
plugin.json Refactored dependency check to use Kubitomakita/Requirements Sep 26, 2018
readme.txt Bumped compatibility to WordPress 5.0 Oct 23, 2018
wordpress-base-plugin.php Added tweak for Composer-managed installations Oct 23, 2018

README.md

Author Latest Version GitHub License Flywheel Donate Analytics Twitter

WordPress Base Plugin

Description

This is a boilerplate WordPress plugin featuring namespace autoloading and Carbon Fields examples. It is intended to be used as a starting point for creating WordPress plugins. It contains several examples and dependencies to get you started.

It may also be used as the means of separating custom code from the theme or extending a child theme.

Contributing

Here are some ways that you can contribute:

  • Suggest improvements and/or code them.
  • Report bugs and/or incompatibilities.
  • Host your sites with Flywheel, use KeyCDN for speedy delivery of assets.

Features

Requirements

  • WordPress 4.7 or higher
  • PHP 5.6 or higher
  • Carbon Fields 2.2 or higher. See the wiki section Carbon Fields for more info.
    • Carbon Fields is only required for the demo. You're welcome to strip out references if you do not wish to use it.

Installation

If you need tips on installing Node.js, Composer, Gulp & Bower, see Installing Dependencies.

The short version:

  1. Clone repository to your plugins directory
  2. Change the four variables in package.json. Modify plugin.json as necessary.
  3. Run npm install; gulp rename; composer install
  4. (optional) For some of the included examples to work, you'll also want to run: bower install; gulp;

You'll want to delete features that you don't like (such as references to TGMPA if you don't need it).

Clone Repository

  1. At command prompt, change to your wp-content/plugins directory.
  2. Clone the repository: git clone https://github.com/dmhendricks/wordpress-base-plugin.git
  3. Renamed the newly created wordpress-base-plugin directory to your own plugin slug.

Next Steps

See the Getting Started documentation for further steps.

Future Goals

  • Add plugin uninstall.php
  • Switch to webpack for frontend dependency management
  • Remove or replace wordpress-settings-api-class example with something actively developed
  • Clean up Carbon Fields custom CSS classes
  • Add automatic GitHub update example
  • Add Gutenberg block examples

Screenshot

Settings Page