WordPress Plugin Boilerplate

Last update: Jul 25, 2022

WordPress Plugin Boilerplate

This repository, developed by the team of Plugins & Snippets, offers an open source WordPress Plugin Template with many useful functions, specially to prepare basic widgets, short codes and settings page. The aim of this Boilerplate Template is to save time for WordPress Developers in building high-quality plugins.

Contents

The WordPress Plugin Template 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 - a fully executable WordPress plugin.

Features

  • The WordPress Plugin Template Boilerplate is based on the Plugin API, Coding Standards, and Documentation Standards.
  • Templates for WordPress widgets and shortcodes.
  • Template to create fast-loading setting page.
  • Includes EDD Software Licensing System, which allows you to sell your plugin by using Easy Digital Downloads and manage future access to plugin updates.
  • Popup to collect User Feedback when deactivating the plugin
  • All classes, functions, and variables are documented
  • The WordPress Plugin Template Boilerplate uses a strict file organization scheme corresponding to the WordPress Plugin Repository structure. This makes it easy to organize the files of your plugin.
  • The plugin template includes a .pot file as a starting point for internationalization.

Installation

The WordPress Plugin Template 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. For example, if your plugin is named 'example-me' then:

  • rename files from plugin-name to example-me
  • change plugin_name to example_me
  • change plugin-name to example-me
  • change Plugin_Name to Example_Me
  • change PLUGIN_NAME_ to EXAMPLE_ME_

It's safe to activate the plugin at this point. Because the WordPress Plugin Template Boilerplate has no real functionality there will be no menu items, meta boxes, or custom post types added until you write the code.

License

The WordPress Plugin Template 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 Template 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.

Includes

Note that if you include your own classes, or third-party libraries, there are three locations in which said files may go:

  • plugin-name/includes is where functionality shared between the admin area and the public-facing parts of the site reside
  • plugin-name/admin is for all admin-specific functionality
  • plugin-name/public is for all public-facing functionality

Note that previous versions of the WordPress Plugin Template Boilerplate did not include Plugin_Name_Loader but this class is used to register all filters and actions with WordPress.

The example code provided shows how to register your hooks with the Loader class.

Credits

The WordPress Plugin Boilerplate Template was developed from 2018 - 2022 by the team of Plugins & Snippets.

The following people contributed to the plugin Dilip Sakariya, Napoleao Wingert and Siawa Ahmed.

Documentation, FAQs, and More

Please feel free to reach out to our team for feedback, comments or suggestions about any additonal feature you like to see included contact us.

If you like this repository, please mark it to be watched and add a star so that you will be notified of any future update.

GitHub

https://github.com/pluginsandsnippets/wordpress-plugin-template-boilerplate
You might also like...

Easy handle APlayer on WordPress. A shortcode for WordPress to using APlayer.

Description Easy handle APlayer on WordPress. A shortcode for WordPress to using APlayer. Support [audio] tag, compatible with AMP. Requirement WordPr

Sep 13, 2021

WordPress & TypeScript. Simple starter template for WordPress projects

WordPress & TypeScript. Simple starter template for WordPress projects that want to use TypeScript in combination with @wordpress/scripts

Jul 24, 2022

A PHP client for Wordpress websites that closely implement the XML-RPC WordPress API

Wordpress XML-RPC PHP Client A PHP client for Wordpress websites that closely implement the XML-RPC WordPress API Created by Hieu Le MIT licensed. Cur

Jun 30, 2022

a wordpress plugin that improves wpgraphql usage together with wpml

WPGraphQL WPML Extension Contributors: rburgst Stable tag: 1.0.6 Tested up to: 5.6.1 Requires at least: 4.9 Requires PHP: 7.0 Requires WPGraphQL: 0.8.

Jul 23, 2022

A WordPress plugin for JAMstack deployments

A WordPress plugin for JAMstack deployments

JAMstack Deployments A WordPress plugin for JAMstack deployments on Netlify (and other platforms). Description This plugin provides a way to fire off

Jun 29, 2022

WordPress Plugin for Magic

WordPress Plugin for Magic

Login by Magic This plugin replaces the standard WordPress login form with one powered by Magic that enables passwordless email magic link login. Plea

Dec 1, 2021

❓ A WordPress plugin to display your site's environment type in the admin bar

Where A WordPress plugin to display your site's environment type in the admin bar. Available Filters where_env_should_add_env_type - Defaults to true

Mar 29, 2022

Wordpress Plugin for displaying content from Notion

notion-content Description Wordpress Plugin for displaying content from Notion using the Notion API. This plugin assumes you have some knowledge of No

Aug 4, 2022

WordPress plugin that allows admin to force logout all users

User Login Control User Login Control is a WordPress plugin allows you to logout user(s) from their account or to see the last activity of your offlin

Jan 26, 2022
Wordless is a junction between a WordPress plugin and a theme boilerplate that dramatically speeds up and enhances your custom theme creation
Wordless is a junction between a WordPress plugin and a theme boilerplate that dramatically speeds up and enhances your custom theme creation

Wordless is a junction between a WordPress plugin and a theme boilerplate that dramatically speeds up and enhances your custom theme creation. Some of

Aug 4, 2022
WordPress Plugin Boilerplate

This repository, developed by the team of Plugins & Snippets, offers an open source WordPress Plugin Template with many useful functions, specially to prepare basic widgets, short codes and settings page. The aim of this Boilerplate Template is to save time for WordPress Developers in building high-quality plugins.

Jul 25, 2022
Tema boilerplate WordPress

WordPress boilerplate based on _s Hi. I'm a starter theme called _s, or underscores, if you like. I'm a theme meant for hacking so don't use me as a P

Dec 16, 2021
The Pronamic WordPress Basecone plugin allows you to connect your WordPress installation to Basecone.

Pronamic WordPress Basecone The Pronamic WordPress Basecone plugin allows you to connect your WordPress installation to Basecone. Table of contents Au

Oct 19, 2021
A WordPress plugin to suspend WordPress sites automagically. Simple and lightweight, no annoying ads and fancy settings.
A WordPress plugin to suspend WordPress sites automagically. Simple and lightweight, no annoying ads and fancy settings.

Suspend WP A WordPress plugin to suspend WordPress sites automagically. Simple and lightweight, no annoying ads and fancy settings. ?? Demo (coming so

Nov 15, 2021
WordPress plugin that lets you use Discourse as the community engine for a WordPress blog

WP Discourse Note: the wp-discourse plugin requires >= PHP-5.4.0. The WP Discourse plugin acts as an interface between your WordPress site and your Di

Aug 4, 2022
Simple WordPress plugin to learn how to understand WordPress Crons and the Action Scheduler library.

Simple WordPress plugin to learn how to understand WordPress Crons and the Action Scheduler library. Import Jamendo playlists with tracks in WordPress posts.

May 24, 2022
A custom WordPress nav walker class to fully implement the Twitter Bootstrap 4.0+ navigation style (v3-branch available for Bootstrap 3) in a custom theme using the WordPress built in menu manager.

WP Bootstrap Navwalker This code in the main repo branch is undergoing a big shakeup to bring it in line with recent standards and to merge and test t

Aug 7, 2022
A curated list of Awesome WordPress Theme, Plugins and Framework development Resources and WordPress Communities.

Awesome WordPress A curated list of Awesome WordPress Theme, Plugins and Framework development Resources and WordPress Communities. Inspired by bayand

Jul 23, 2022
Twenty Twenty-Two, the default WordPress theme that will launch with WordPress 5.9.
Twenty Twenty-Two, the default WordPress theme that will launch with WordPress 5.9.

Twenty Twenty-Two Welcome to the development repository for the default theme that will launch with WordPress 5.9. About Twenty Twenty-Two is designed

Aug 5, 2022