Skip to content

dmhendricks/wordpress-base-plugin

Repository files navigation

Author Donate WP Engine GitHub License Twitter

WordPress Base Plugin

Description

This is a boilerplate WordPress plugin featuring namespace autoloading and integration with Carbon Fields. 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.

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 plugins
  2. Change the four variables in package.json
  3. Run npm install; gulp rename; composer install

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 Plans

  • Add Customizer example
  • Add dynamically-created CSS/JS files based on settings
  • Refactor the Plugin class for better organization and self-documentation
  • Create decent documentation and perform cleanup on the wordpress-toolkit dependency
  • Add phpdotenv support
  • Add encrypted text field example
  • Add some useful Carbon Fields CSS classes

Change Log

Release changes are noted on the Releases page.

Branch: master

  • None since release

Credits

Please support humans.txt. It's an initiative for knowing the people behind a web site. It's an unobtrusive text file that contains information about the different people who have contributed to building the web site.

Carbon Fields

URL: http://carbonfields.net/
Author: htmlBurger.com
Twitter: @htmlburger
Author URI: https://htmlburger.com/
Location: London, England

WPGulp

URL: https://labs.ahmadawais.com/WPGulp/
Author: Ahmad Awais
Twitter: @mrahmadawais
Author URI: https://ahmadawais.com/
Location: Asal, Pakistan

PostTypes

URL: https://github.com/jjgrainger/PostTypes/
Author: Joe Grainger
Twitter: @jjgrainger
Author URI: https://jjgrainger.co.uk/
Location: Falmouth, England

Screenshot

Settings Page

About

A starter template for WordPress plugins, with autoloading, namespaces and object caching (where available).

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors