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.

README.md

Author Latest Version GitHub License StackShare CloudVerve, LLC Donate 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.
  • Test the translation mechanisms - they have not been extensively tested yet.
  • Report bugs and/or incompatibilities

Features

Note: Gulp and Bower are optional, but handy. If you do not wish to use them, you can delete the references.

Requirements

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;

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 support
  • Add support for Gulp 4.0
  • Switch to npm and WebPack for frontend dependency management
  • Remove or replace tareq1988/wordpress-settings-api-class examples with something actively developed
  • Clean up Carbon Fields custom CSS classes
  • Allow cache flushing by group
  • Add Gutenberg examples

Change Log

Release changes are noted on the Releases page.

Branch: master

  • None since release

Screenshot

Settings Page

Analytics