From d2a71ed513bc881c15bae22aa87ad7ce437012e5 Mon Sep 17 00:00:00 2001 From: Rob Gabaree Date: Tue, 2 Sep 2014 12:26:08 -0400 Subject: [PATCH 01/19] Fix incorrect date in ChangeLog.md --- ChangeLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ChangeLog.md b/ChangeLog.md index 151eee6..cfab9e8 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,3 +1,3 @@ # ChangeLog -* (1 September 2015). Initial Release +* (1 September 2014). Initial Release From 50f2a612f80f8037abdf87c41f7c21d46b23f1aa Mon Sep 17 00:00:00 2001 From: Rob Gabaree Date: Tue, 2 Sep 2014 13:16:20 -0400 Subject: [PATCH 02/19] Fix typo in plugin-name.php --- plugin-name/trunk/plugin-name.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin-name/trunk/plugin-name.php b/plugin-name/trunk/plugin-name.php index dc2b43b..81c5c06 100644 --- a/plugin-name/trunk/plugin-name.php +++ b/plugin-name/trunk/plugin-name.php @@ -6,7 +6,7 @@ * This file is read by WordPress to generate the plugin information in the plugin * Dashboard. This file also includes all of the dependencies used by the plugin, * registers the activation and deactivation functions, and defines a function - * this starts the plugin. + * that starts the plugin. * * @link http://example.com * @since 1.0.0 From 06605429d32a712c503bbd8848a946b79878467c Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 3 Sep 2014 09:26:49 -0400 Subject: [PATCH 03/19] describe how to install the Boilerplate. Updating the `README` to describe how to install the Boilerplate. Fixes #213 --- ChangeLog.md | 1 + README.md | 16 +++++++++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/ChangeLog.md b/ChangeLog.md index cfab9e8..8e111ab 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,3 +1,4 @@ # ChangeLog +* (3 September 2014). Updating the `README` to describe how to install the Boilerplate. * (1 September 2014). Initial Release diff --git a/README.md b/README.md index a8971ff..9169bde 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,25 @@ The WordPress Plugin Boilerplate includes the following files: ## Installation -1. Copy the `plugin-name` directory into your `wp-content/plugins` directory. +The Boilerplate can be installed in one of two ways both of which are documented below. Note that because of its directory structure, the Boilerplate cannot be installed “as-is.” + +Instead, the options are: + +### Copying a Directory + +1. Copy the `trunk` directory into your `wp-content/plugins` directory. You may wish to rename this to something else. 2. In the WordPress dashboard, navigation to the *Plugins* page Locate the menu item that reads “The WordPress Plugin Boilerplate.” 3. Click on *Activate.* +### Create a Symbolic Link + +1. Copy the `WordPress-Plugin-Boilerplate` directory into your `wp-content/plugins` directory. +2. Create a symbolic link between the `trunk` directory and the plugin. For example: `ln -s plugin-name/trunk /path/to/wordpress/wp-content/plugins/plugin-name` +3. In the WordPress dashboard, navigation to the *Plugins* page +Locate the menu item that reads “The WordPress Plugin Boilerplate.” +4. Click on *Activate.* + Note that this will activate the source code of the Boilerplate, but because the Boilerplate has no real functionality so no menu items, meta boxes, or custom post types will be added. Examples are slated to be added to the [Boilerplate’s website](http://wppb.io) as the site continues to grow. From 8f002bfc4d8b0db3bbff850aba733e450db9268a Mon Sep 17 00:00:00 2001 From: jessertaylor Date: Wed, 3 Sep 2014 15:11:55 +0100 Subject: [PATCH 04/19] Fixed deactivation hook in plugin_name.php --- plugin-name/trunk/plugin-name.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin-name/trunk/plugin-name.php b/plugin-name/trunk/plugin-name.php index 81c5c06..2bc4f2b 100644 --- a/plugin-name/trunk/plugin-name.php +++ b/plugin-name/trunk/plugin-name.php @@ -44,7 +44,7 @@ require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-deactivat register_activation_hook( __FILE__, array( 'Plugin_Name_Activator', 'activate' ) ); /** This action is documented in includes/class-plugin-name-deactivator.php */ -register_activation_hook( __FILE__, array( 'Plugin_Name_Deactivator', 'deactivate' ) ); +register_deactivation_hook( __FILE__, array( 'Plugin_Name_Deactivator', 'deactivate' ) ); /** * The core plugin class that is used to define internationalization, From 16c93f8548873ea4f0186710f120281985866c7e Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Thu, 4 Sep 2014 09:44:54 -0400 Subject: [PATCH 05/19] Adding instructions for Windows symlinks Fixes #213 --- ChangeLog.md | 3 ++- README.md | 20 +++++++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/ChangeLog.md b/ChangeLog.md index 8e111ab..52cf6ad 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,4 +1,5 @@ # ChangeLog +* (4 September 2014). Updating the `README` with Windows symbolic link instructions. * (3 September 2014). Updating the `README` to describe how to install the Boilerplate. -* (1 September 2014). Initial Release +* (1 September 2014). Initial Release. diff --git a/README.md b/README.md index 9169bde..8b03f79 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,9 @@ Instead, the options are: Locate the menu item that reads “The WordPress Plugin Boilerplate.” 3. Click on *Activate.* -### Create a Symbolic Link +### Creating a Symbolic Link + +#### On Linux or OS X 1. Copy the `WordPress-Plugin-Boilerplate` directory into your `wp-content/plugins` directory. 2. Create a symbolic link between the `trunk` directory and the plugin. For example: `ln -s plugin-name/trunk /path/to/wordpress/wp-content/plugins/plugin-name` @@ -39,6 +41,14 @@ Locate the menu item that reads “The WordPress Plugin Boilerplate.” Locate the menu item that reads “The WordPress Plugin Boilerplate.” 4. Click on *Activate.* +#### On Windows + +1. Copy the `WordPress-Plugin-Boilerplate` directory into your `wp-content/plugins` directory. +2. Create a symbolic link between the `trunk` directory and the plugin. For example: `mklink /J path\to\wp-content\plugins \path\to\WordPress-Plugin-Boilerplate\trunk\plugin-name` +3. In the WordPress dashboard, navigation to the *Plugins* page +Locate the menu item that reads “The WordPress Plugin Boilerplate.” +4. Click on *Activate.* + Note that this will activate the source code of the Boilerplate, but because the Boilerplate has no real functionality so no menu items, meta boxes, or custom post types will be added. Examples are slated to be added to the [Boilerplate’s website](http://wppb.io) as the site continues to grow. @@ -107,9 +117,9 @@ When committing code to the WordPress Plugin Repository, all of the banner, icon ### What About Other Features? -The previous version of the WordPress Plugin Boilerplate included support for a number of different projects such as the [GitHub Updater](https://github.com/afragen/github-updater). +The previous version of the WordPress Plugin Boilerplate included support for a number of different projects such as the [GitHub Updater](https://github.com/afragen/github-updater). -These tools are not part of the core of this Boilerplate, as I see them as being additions, forks, or other contributions to the Boilerplate. +These tools are not part of the core of this Boilerplate, as I see them as being additions, forks, or other contributions to the Boilerplate. The same is true of using tools like Grunt, Composer, etc. These are all fantastic tools, but not everyone uses them. In order to keep the core Boilerplate as light as possible, this feature have been removed and will be introduced in other editions, and will be listed and maintained on the project homepage @@ -117,10 +127,10 @@ The same is true of using tools like Grunt, Composer, etc. These are all fantast The WordPress Plugin Boilerplate was started in 2011 by [Tom McFarlin](http://twitter.com/tommcfarlin/) and his since included a number of great contributions. -The current version of the Boilerplate was developed in conjunction with [Josh Eaton](https://twitter.com/jjeaton), [Ulrich Pogson](https://twitter.com/grapplerulrich), and [Brad Vincent](https://twitter.com/themergency). +The current version of the Boilerplate was developed in conjunction with [Josh Eaton](https://twitter.com/jjeaton), [Ulrich Pogson](https://twitter.com/grapplerulrich), and [Brad Vincent](https://twitter.com/themergency). The homepage is based on a design as provided by [HTML5Up](http://html5up.net), the Boilerplate logo was designed by Rob McCaskill of [BungaWeb](http://bungaweb.com), and the site `favicon` was created by [Mickey Kay](https://twitter.com/McGuive7). ## Documentation, FAQs, and More -Because this version is a major rewrite of the core plugin, we’re working to create an entire site around the Boilerplate. If you’re interested, please [let me know](http://tommcfarlin.com/contact) and we’ll see what we can do. \ No newline at end of file +Because this version is a major rewrite of the core plugin, we’re working to create an entire site around the Boilerplate. If you’re interested, please [let me know](http://tommcfarlin.com/contact) and we’ll see what we can do. \ No newline at end of file From 50bc54145543495f3ec44075742738aab55b5712 Mon Sep 17 00:00:00 2001 From: Justin Sainton Date: Wed, 10 Sep 2014 21:19:37 -0700 Subject: [PATCH 06/19] Please stop shouting at me. I do hate when my parents shout. But in all seriousness, shouting types is bad form. --- plugin-name/trunk/admin/class-plugin-name-admin.php | 2 +- plugin-name/trunk/includes/class-plugin-name-i18n.php | 2 +- plugin-name/trunk/public/class-plugin-name-public.php | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/plugin-name/trunk/admin/class-plugin-name-admin.php b/plugin-name/trunk/admin/class-plugin-name-admin.php index 1b365f2..8c45472 100644 --- a/plugin-name/trunk/admin/class-plugin-name-admin.php +++ b/plugin-name/trunk/admin/class-plugin-name-admin.php @@ -96,7 +96,7 @@ class Plugin_Name_Admin { * class. */ - wp_enqueue_script( $this->name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-admin.js', array( 'jquery' ), $this->version, FALSE ); + wp_enqueue_script( $this->name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-admin.js', array( 'jquery' ), $this->version, false ); } diff --git a/plugin-name/trunk/includes/class-plugin-name-i18n.php b/plugin-name/trunk/includes/class-plugin-name-i18n.php index 4123844..08caf9e 100644 --- a/plugin-name/trunk/includes/class-plugin-name-i18n.php +++ b/plugin-name/trunk/includes/class-plugin-name-i18n.php @@ -44,7 +44,7 @@ class Plugin_Name_i18n { load_plugin_textdomain( $this->domain, - FALSE, + false, dirname( dirname( plugin_basename( __FILE__ ) ) ) . '/languages/' ); diff --git a/plugin-name/trunk/public/class-plugin-name-public.php b/plugin-name/trunk/public/class-plugin-name-public.php index b42cb51..2879ab4 100644 --- a/plugin-name/trunk/public/class-plugin-name-public.php +++ b/plugin-name/trunk/public/class-plugin-name-public.php @@ -96,7 +96,7 @@ class Plugin_Name_Public { * class. */ - wp_enqueue_script( $this->name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-public.js', array( 'jquery' ), $this->version, FALSE ); + wp_enqueue_script( $this->name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-public.js', array( 'jquery' ), $this->version, false ); } From 163c2a86c1449377ab0f6b406ce8551a2728572e Mon Sep 17 00:00:00 2001 From: Dmitry Mayorov Date: Sun, 5 Oct 2014 19:35:03 +0600 Subject: [PATCH 07/19] Update class-plugin-name-admin.php Changed @subpackage from 'includes' to 'admin'. --- plugin-name/trunk/admin/class-plugin-name-admin.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin-name/trunk/admin/class-plugin-name-admin.php b/plugin-name/trunk/admin/class-plugin-name-admin.php index 8c45472..a92f801 100644 --- a/plugin-name/trunk/admin/class-plugin-name-admin.php +++ b/plugin-name/trunk/admin/class-plugin-name-admin.php @@ -7,7 +7,7 @@ * @since 1.0.0 * * @package Plugin_Name - * @subpackage Plugin_Name/includes + * @subpackage Plugin_Name/admin */ /** From 7a12d6aa66cf6a7f0d17e75c2b576d73aa92ec10 Mon Sep 17 00:00:00 2001 From: Dmitry Mayorov Date: Sun, 5 Oct 2014 19:36:55 +0600 Subject: [PATCH 08/19] Update class-plugin-name-public.php Updated @subpackage from 'admin' to 'public' --- plugin-name/trunk/public/class-plugin-name-public.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugin-name/trunk/public/class-plugin-name-public.php b/plugin-name/trunk/public/class-plugin-name-public.php index 2879ab4..b1ab2ee 100644 --- a/plugin-name/trunk/public/class-plugin-name-public.php +++ b/plugin-name/trunk/public/class-plugin-name-public.php @@ -7,7 +7,7 @@ * @since 1.0.0 * * @package Plugin_Name - * @subpackage Plugin_Name/includes + * @subpackage Plugin_Name/public */ /** @@ -17,7 +17,7 @@ * enqueue the dashboard-specific stylesheet and JavaScript. * * @package Plugin_Name - * @subpackage Plugin_Name/admin + * @subpackage Plugin_Name/public * @author Your Name */ class Plugin_Name_Public { From dbf2c73757cb0d7c01eabf5e1dffb0322f1b56e5 Mon Sep 17 00:00:00 2001 From: mAAdhaTTah Date: Tue, 7 Oct 2014 16:43:55 -0400 Subject: [PATCH 09/19] Change name -> plugin_name for consistency --- .../trunk/admin/class-plugin-name-admin.php | 14 +++++++------- .../trunk/public/class-plugin-name-public.php | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/plugin-name/trunk/admin/class-plugin-name-admin.php b/plugin-name/trunk/admin/class-plugin-name-admin.php index 8c45472..963d871 100644 --- a/plugin-name/trunk/admin/class-plugin-name-admin.php +++ b/plugin-name/trunk/admin/class-plugin-name-admin.php @@ -27,9 +27,9 @@ class Plugin_Name_Admin { * * @since 1.0.0 * @access private - * @var string $name The ID of this plugin. + * @var string $plugin_name The ID of this plugin. */ - private $name; + private $plugin_name; /** * The version of this plugin. @@ -44,12 +44,12 @@ class Plugin_Name_Admin { * Initialize the class and set its properties. * * @since 1.0.0 - * @var string $name The name of this plugin. + * @var string $plugin_name The name of this plugin. * @var string $version The version of this plugin. */ - public function __construct( $name, $version ) { + public function __construct( $plugin_name, $version ) { - $this->name = $name; + $this->plugin_name = $plugin_name; $this->version = $version; } @@ -73,7 +73,7 @@ class Plugin_Name_Admin { * class. */ - wp_enqueue_style( $this->name, plugin_dir_url( __FILE__ ) . 'css/plugin-name-admin.css', array(), $this->version, 'all' ); + wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/plugin-name-admin.css', array(), $this->version, 'all' ); } @@ -96,7 +96,7 @@ class Plugin_Name_Admin { * class. */ - wp_enqueue_script( $this->name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-admin.js', array( 'jquery' ), $this->version, false ); + wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-admin.js', array( 'jquery' ), $this->version, false ); } diff --git a/plugin-name/trunk/public/class-plugin-name-public.php b/plugin-name/trunk/public/class-plugin-name-public.php index 2879ab4..c47dfb4 100644 --- a/plugin-name/trunk/public/class-plugin-name-public.php +++ b/plugin-name/trunk/public/class-plugin-name-public.php @@ -27,9 +27,9 @@ class Plugin_Name_Public { * * @since 1.0.0 * @access private - * @var string $name The ID of this plugin. + * @var string $plugin_name The ID of this plugin. */ - private $name; + private $plugin_name; /** * The version of this plugin. @@ -44,12 +44,12 @@ class Plugin_Name_Public { * Initialize the class and set its properties. * * @since 1.0.0 - * @var string $name The name of the plugin. + * @var string $plugin_name The name of the plugin. * @var string $version The version of this plugin. */ - public function __construct( $name, $version ) { + public function __construct( $plugin_name, $version ) { - $this->name = $name; + $this->plugin_name = $plugin_name; $this->version = $version; } @@ -73,7 +73,7 @@ class Plugin_Name_Public { * class. */ - wp_enqueue_style( $this->name, plugin_dir_url( __FILE__ ) . 'css/plugin-name-public.css', array(), $this->version, 'all' ); + wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/plugin-name-public.css', array(), $this->version, 'all' ); } @@ -96,7 +96,7 @@ class Plugin_Name_Public { * class. */ - wp_enqueue_script( $this->name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-public.js', array( 'jquery' ), $this->version, false ); + wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-public.js', array( 'jquery' ), $this->version, false ); } From 2960b6c1c875d52f625d862b6e1a28dd4e6f4110 Mon Sep 17 00:00:00 2001 From: Nikhil Vimal Date: Tue, 4 Nov 2014 16:47:16 -0600 Subject: [PATCH 10/19] Fixing require() vs require_once() See : https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate/issues/222. I believe this was in favor of doing it "correctly"? --- plugin-name/trunk/plugin-name.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin-name/trunk/plugin-name.php b/plugin-name/trunk/plugin-name.php index 2bc4f2b..82d8b1b 100644 --- a/plugin-name/trunk/plugin-name.php +++ b/plugin-name/trunk/plugin-name.php @@ -50,7 +50,7 @@ register_deactivation_hook( __FILE__, array( 'Plugin_Name_Deactivator', 'deactiv * The core plugin class that is used to define internationalization, * dashboard-specific hooks, and public-facing site hooks. */ -require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name.php'; +require plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name.php'; /** * Begins execution of the plugin. From f51ee23a1f984088700d7e599478a9752d3d83d8 Mon Sep 17 00:00:00 2001 From: Barry Ceelen Date: Mon, 10 Nov 2014 16:57:08 +0100 Subject: [PATCH 11/19] Fix code comment typo --- plugin-name/trunk/includes/class-plugin-name-i18n.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugin-name/trunk/includes/class-plugin-name-i18n.php b/plugin-name/trunk/includes/class-plugin-name-i18n.php index 08caf9e..4958ab9 100644 --- a/plugin-name/trunk/includes/class-plugin-name-i18n.php +++ b/plugin-name/trunk/includes/class-plugin-name-i18n.php @@ -4,7 +4,7 @@ * Define the internationalization functionality * * Loads and defines the internationalization files for this plugin - * so that its ready for translation. + * so that it is ready for translation. * * @link http://example.com * @since 1.0.0 @@ -17,7 +17,7 @@ * Define the internationalization functionality. * * Loads and defines the internationalization files for this plugin - * so that its ready for translation. + * so that it is ready for translation. * * @since 1.0.0 * @package Plugin_Name From e015b9cd7c402167aa526c20be9c53e2aa17845d Mon Sep 17 00:00:00 2001 From: Tony Hesjevik Date: Mon, 17 Nov 2014 23:33:00 +1100 Subject: [PATCH 12/19] Create functions for activation and deactivation hooks. Moving the activation and deactivation hooks into its own functions, makes so we dont have to include class-plugin-name-deactivator and class-plugin-name-activator on every page load. --- plugin-name/trunk/plugin-name.php | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/plugin-name/trunk/plugin-name.php b/plugin-name/trunk/plugin-name.php index 82d8b1b..26edc22 100644 --- a/plugin-name/trunk/plugin-name.php +++ b/plugin-name/trunk/plugin-name.php @@ -32,19 +32,24 @@ if ( ! defined( 'WPINC' ) ) { /** * The code that runs during plugin activation. + * This action is documented in includes/class-plugin-name-activator.php */ -require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-activator.php'; +function activate_plugin_name() { + require_once __DIR__ . 'includes/class-plugin-name-activator.php'; + Plugin_Name_Activator::activate(); +} /** * The code that runs during plugin deactivation. + * This action is documented in includes/class-plugin-name-deactivator.php */ -require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-deactivator.php'; +function deactivate_plugin_name() { + require_once __DIR__ . 'includes/class-plugin-name-deactivator.php'; + Plugin_Name_Deactivator::deactivate(); +} -/** This action is documented in includes/class-plugin-name-activator.php */ -register_activation_hook( __FILE__, array( 'Plugin_Name_Activator', 'activate' ) ); - -/** This action is documented in includes/class-plugin-name-deactivator.php */ -register_deactivation_hook( __FILE__, array( 'Plugin_Name_Deactivator', 'deactivate' ) ); +register_activation_hook( __FILE__, 'activate_plugin_name' ); +register_deactivation_hook( __FILE__, 'deactivate_plugin_name' ); /** * The core plugin class that is used to define internationalization, From 042c13b7b1e2943ba789e5255e8bd03b9fe2d35c Mon Sep 17 00:00:00 2001 From: Federico Ramirez Date: Wed, 19 Nov 2014 09:25:59 -0300 Subject: [PATCH 13/19] Use the same syntax for all included files I was having issues activating the plugin, and it was because of the way the files were beeing included, this fixes it. --- plugin-name/trunk/plugin-name.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugin-name/trunk/plugin-name.php b/plugin-name/trunk/plugin-name.php index 26edc22..8779850 100644 --- a/plugin-name/trunk/plugin-name.php +++ b/plugin-name/trunk/plugin-name.php @@ -35,7 +35,7 @@ if ( ! defined( 'WPINC' ) ) { * This action is documented in includes/class-plugin-name-activator.php */ function activate_plugin_name() { - require_once __DIR__ . 'includes/class-plugin-name-activator.php'; + require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-activator.php'; Plugin_Name_Activator::activate(); } @@ -44,7 +44,7 @@ function activate_plugin_name() { * This action is documented in includes/class-plugin-name-deactivator.php */ function deactivate_plugin_name() { - require_once __DIR__ . 'includes/class-plugin-name-deactivator.php'; + require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-deactivator.php'; Plugin_Name_Deactivator::deactivate(); } From 411b1d19b9d3f67af5aba025a5272835307e836e Mon Sep 17 00:00:00 2001 From: Travis Northcutt Date: Wed, 26 Nov 2014 09:57:22 -0600 Subject: [PATCH 14/19] Fix minor typo in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b03f79..5aaa136 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ The same is true of using tools like Grunt, Composer, etc. These are all fantast # Credits -The WordPress Plugin Boilerplate was started in 2011 by [Tom McFarlin](http://twitter.com/tommcfarlin/) and his since included a number of great contributions. +The WordPress Plugin Boilerplate was started in 2011 by [Tom McFarlin](http://twitter.com/tommcfarlin/) and has since included a number of great contributions. The current version of the Boilerplate was developed in conjunction with [Josh Eaton](https://twitter.com/jjeaton), [Ulrich Pogson](https://twitter.com/grapplerulrich), and [Brad Vincent](https://twitter.com/themergency). @@ -133,4 +133,4 @@ The homepage is based on a design as provided by [HTML5Up](http://html5up.net), ## Documentation, FAQs, and More -Because this version is a major rewrite of the core plugin, we’re working to create an entire site around the Boilerplate. If you’re interested, please [let me know](http://tommcfarlin.com/contact) and we’ll see what we can do. \ No newline at end of file +Because this version is a major rewrite of the core plugin, we’re working to create an entire site around the Boilerplate. If you’re interested, please [let me know](http://tommcfarlin.com/contact) and we’ll see what we can do. From 78624f6cdd5f34ecb6582862f7f4379fcd6d34fc Mon Sep 17 00:00:00 2001 From: Scott Walkinshaw Date: Mon, 5 Jan 2015 11:39:36 -0500 Subject: [PATCH 15/19] Fix CHANGELOG filename --- ChangeLog.md => CHANGELOG.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename ChangeLog.md => CHANGELOG.md (94%) diff --git a/ChangeLog.md b/CHANGELOG.md similarity index 94% rename from ChangeLog.md rename to CHANGELOG.md index 52cf6ad..8ff0039 100644 --- a/ChangeLog.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# ChangeLog +# Changelog * (4 September 2014). Updating the `README` with Windows symbolic link instructions. * (3 September 2014). Updating the `README` to describe how to install the Boilerplate. diff --git a/README.md b/README.md index 5aaa136..0bb4ff3 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A standardized, organized, object-oriented foundation for building high-quality 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. +* `CHANGELOG.md`. The list of changes to the core project. * `README.md`. The file that you’re currently reading. * A `plugin-name` subdirectory that contains the source code - a fully executable WordPress plugin. From 582ccadde08c6c6bb071d8d1973f668629dacb65 Mon Sep 17 00:00:00 2001 From: Donna Murphy Date: Sat, 17 Jan 2015 12:45:15 -0500 Subject: [PATCH 16/19] Fix incorrect class names --- plugin-name/trunk/admin/class-plugin-name-admin.php | 8 ++++---- plugin-name/trunk/public/class-plugin-name-public.php | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/plugin-name/trunk/admin/class-plugin-name-admin.php b/plugin-name/trunk/admin/class-plugin-name-admin.php index 6abed91..0949d6f 100644 --- a/plugin-name/trunk/admin/class-plugin-name-admin.php +++ b/plugin-name/trunk/admin/class-plugin-name-admin.php @@ -65,10 +65,10 @@ class Plugin_Name_Admin { * This function is provided for demonstration purposes only. * * An instance of this class should be passed to the run() function - * defined in Plugin_Name_Admin_Loader as all of the hooks are defined + * defined in Plugin_Name_Loader as all of the hooks are defined * in that particular class. * - * The Plugin_Name_Admin_Loader will then create the relationship + * The Plugin_Name_Loader will then create the relationship * between the defined hooks and the functions defined in this * class. */ @@ -88,10 +88,10 @@ class Plugin_Name_Admin { * This function is provided for demonstration purposes only. * * An instance of this class should be passed to the run() function - * defined in Plugin_Name_Admin_Loader as all of the hooks are defined + * defined in Plugin_Name_Loader as all of the hooks are defined * in that particular class. * - * The Plugin_Name_Admin_Loader will then create the relationship + * The Plugin_Name_Loader will then create the relationship * between the defined hooks and the functions defined in this * class. */ diff --git a/plugin-name/trunk/public/class-plugin-name-public.php b/plugin-name/trunk/public/class-plugin-name-public.php index 7f0962d..28fc9b7 100644 --- a/plugin-name/trunk/public/class-plugin-name-public.php +++ b/plugin-name/trunk/public/class-plugin-name-public.php @@ -65,10 +65,10 @@ class Plugin_Name_Public { * This function is provided for demonstration purposes only. * * An instance of this class should be passed to the run() function - * defined in Plugin_Name_Public_Loader as all of the hooks are defined + * defined in Plugin_Name_Loader as all of the hooks are defined * in that particular class. * - * The Plugin_Name_Public_Loader will then create the relationship + * The Plugin_Name_Loader will then create the relationship * between the defined hooks and the functions defined in this * class. */ @@ -88,10 +88,10 @@ class Plugin_Name_Public { * This function is provided for demonstration purposes only. * * An instance of this class should be passed to the run() function - * defined in Plugin_Name_Public_Loader as all of the hooks are defined + * defined in Plugin_Name_Loader as all of the hooks are defined * in that particular class. * - * The Plugin_Name_Public_Loader will then create the relationship + * The Plugin_Name_Loader will then create the relationship * between the defined hooks and the functions defined in this * class. */ From 2683f494eae02f939b3a342ca53aef8fed42d96f Mon Sep 17 00:00:00 2001 From: Chris Wilcoxson Date: Tue, 3 Feb 2015 11:15:28 -0600 Subject: [PATCH 17/19] Function docs should be @param not @var. --- .../trunk/admin/class-plugin-name-admin.php | 4 +-- .../includes/class-plugin-name-loader.php | 32 +++++++++---------- .../trunk/public/class-plugin-name-public.php | 4 +-- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/plugin-name/trunk/admin/class-plugin-name-admin.php b/plugin-name/trunk/admin/class-plugin-name-admin.php index 0949d6f..25944dc 100644 --- a/plugin-name/trunk/admin/class-plugin-name-admin.php +++ b/plugin-name/trunk/admin/class-plugin-name-admin.php @@ -44,8 +44,8 @@ class Plugin_Name_Admin { * Initialize the class and set its properties. * * @since 1.0.0 - * @var string $plugin_name The name of this plugin. - * @var string $version The version of this plugin. + * @param string $plugin_name The name of this plugin. + * @param string $version The version of this plugin. */ public function __construct( $plugin_name, $version ) { diff --git a/plugin-name/trunk/includes/class-plugin-name-loader.php b/plugin-name/trunk/includes/class-plugin-name-loader.php index 16398d1..3d2febc 100644 --- a/plugin-name/trunk/includes/class-plugin-name-loader.php +++ b/plugin-name/trunk/includes/class-plugin-name-loader.php @@ -57,11 +57,11 @@ class Plugin_Name_Loader { * Add a new action to the collection to be registered with WordPress. * * @since 1.0.0 - * @var string $hook The name of the WordPress action that is being registered. - * @var object $component A reference to the instance of the object on which the action is defined. - * @var string $callback The name of the function definition on the $component. - * @var int Optional $priority The priority at which the function should be fired. - * @var int Optional $accepted_args The number of arguments that should be passed to the $callback. + * @param string $hook The name of the WordPress action that is being registered. + * @param object $component A reference to the instance of the object on which the action is defined. + * @param string $callback The name of the function definition on the $component. + * @param int Optional $priority The priority at which the function should be fired. + * @param int Optional $accepted_args The number of arguments that should be passed to the $callback. */ public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { $this->actions = $this->add( $this->actions, $hook, $component, $callback, $priority, $accepted_args ); @@ -71,11 +71,11 @@ class Plugin_Name_Loader { * Add a new filter to the collection to be registered with WordPress. * * @since 1.0.0 - * @var string $hook The name of the WordPress filter that is being registered. - * @var object $component A reference to the instance of the object on which the filter is defined. - * @var string $callback The name of the function definition on the $component. - * @var int Optional $priority The priority at which the function should be fired. - * @var int Optional $accepted_args The number of arguments that should be passed to the $callback. + * @param string $hook The name of the WordPress filter that is being registered. + * @param object $component A reference to the instance of the object on which the filter is defined. + * @param string $callback The name of the function definition on the $component. + * @param int Optional $priority The priority at which the function should be fired. + * @param int Optional $accepted_args The number of arguments that should be passed to the $callback. */ public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { $this->filters = $this->add( $this->filters, $hook, $component, $callback, $priority, $accepted_args ); @@ -87,12 +87,12 @@ class Plugin_Name_Loader { * * @since 1.0.0 * @access private - * @var array $hooks The collection of hooks that is being registered (that is, actions or filters). - * @var string $hook The name of the WordPress filter that is being registered. - * @var object $component A reference to the instance of the object on which the filter is defined. - * @var string $callback The name of the function definition on the $component. - * @var int Optional $priority The priority at which the function should be fired. - * @var int Optional $accepted_args The number of arguments that should be passed to the $callback. + * @param array $hooks The collection of hooks that is being registered (that is, actions or filters). + * @param string $hook The name of the WordPress filter that is being registered. + * @param object $component A reference to the instance of the object on which the filter is defined. + * @param string $callback The name of the function definition on the $component. + * @param int Optional $priority The priority at which the function should be fired. + * @param int Optional $accepted_args The number of arguments that should be passed to the $callback. * @return type The collection of actions and filters registered with WordPress. */ private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) { diff --git a/plugin-name/trunk/public/class-plugin-name-public.php b/plugin-name/trunk/public/class-plugin-name-public.php index 28fc9b7..a65c7fe 100644 --- a/plugin-name/trunk/public/class-plugin-name-public.php +++ b/plugin-name/trunk/public/class-plugin-name-public.php @@ -44,8 +44,8 @@ class Plugin_Name_Public { * Initialize the class and set its properties. * * @since 1.0.0 - * @var string $plugin_name The name of the plugin. - * @var string $version The version of this plugin. + * @param string $plugin_name The name of the plugin. + * @param string $version The version of this plugin. */ public function __construct( $plugin_name, $version ) { From 9c14d6e3ebc6399ca65998aa8db3731dcb55fb9f Mon Sep 17 00:00:00 2001 From: Jan Beck Date: Fri, 13 Feb 2015 14:31:40 -0400 Subject: [PATCH 18/19] changed "dashboard" to "admin area" dashboard-specific becomes admin-specific --- README.md | 10 +++++----- plugin-name/trunk/admin/class-plugin-name-admin.php | 10 +++++----- plugin-name/trunk/admin/css/plugin-name-admin.css | 2 +- plugin-name/trunk/admin/js/plugin-name-admin.js | 2 +- .../admin/partials/plugin-name-admin-display.php | 4 ++-- plugin-name/trunk/includes/class-plugin-name.php | 12 ++++++------ plugin-name/trunk/plugin-name.php | 6 +++--- .../trunk/public/class-plugin-name-public.php | 2 +- 8 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 0bb4ff3..8b33d1b 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Instead, the options are: ### Copying a Directory 1. Copy the `trunk` directory into your `wp-content/plugins` directory. You may wish to rename this to something else. -2. In the WordPress dashboard, navigation to the *Plugins* page +2. In the WordPress admin area, navigation to the *Plugins* page Locate the menu item that reads “The WordPress Plugin Boilerplate.” 3. Click on *Activate.* @@ -37,7 +37,7 @@ Locate the menu item that reads “The WordPress Plugin Boilerplate.” 1. Copy the `WordPress-Plugin-Boilerplate` directory into your `wp-content/plugins` directory. 2. Create a symbolic link between the `trunk` directory and the plugin. For example: `ln -s plugin-name/trunk /path/to/wordpress/wp-content/plugins/plugin-name` -3. In the WordPress dashboard, navigation to the *Plugins* page +3. In the WordPress admin area, navigation to the *Plugins* page Locate the menu item that reads “The WordPress Plugin Boilerplate.” 4. Click on *Activate.* @@ -45,7 +45,7 @@ Locate the menu item that reads “The WordPress Plugin Boilerplate.” 1. Copy the `WordPress-Plugin-Boilerplate` directory into your `wp-content/plugins` directory. 2. Create a symbolic link between the `trunk` directory and the plugin. For example: `mklink /J path\to\wp-content\plugins \path\to\WordPress-Plugin-Boilerplate\trunk\plugin-name` -3. In the WordPress dashboard, navigation to the *Plugins* page +3. In the WordPress admin area, navigation to the *Plugins* page Locate the menu item that reads “The WordPress Plugin Boilerplate.” 4. Click on *Activate.* @@ -89,8 +89,8 @@ For reference, [here's a discussion](http://make.wordpress.org/themes/2013/03/04 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 dashboard and the public-facing parts of the side reside -* `plugin-name/admin` is for all dashboard-specific functionality +* `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 Boilerplate did not include `Plugin_Name_Loader` but this class is used to register all filters and actions with WordPress. diff --git a/plugin-name/trunk/admin/class-plugin-name-admin.php b/plugin-name/trunk/admin/class-plugin-name-admin.php index 25944dc..3ef8d60 100644 --- a/plugin-name/trunk/admin/class-plugin-name-admin.php +++ b/plugin-name/trunk/admin/class-plugin-name-admin.php @@ -1,7 +1,7 @@ Date: Wed, 4 Mar 2015 15:21:25 -0500 Subject: [PATCH 19/19] Updated Readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added a note about current project lead and pointing inquires away from Tom’s contact form. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0bb4ff3..e77341f 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ The same is true of using tools like Grunt, Composer, etc. These are all fantast # Credits -The WordPress Plugin Boilerplate was started in 2011 by [Tom McFarlin](http://twitter.com/tommcfarlin/) and has since included a number of great contributions. +The WordPress Plugin Boilerplate was started in 2011 by [Tom McFarlin](http://twitter.com/tommcfarlin/) and has since included a number of great contributions. In March of 2015 the project was handed over by Tom to Devin Vinson. The current version of the Boilerplate was developed in conjunction with [Josh Eaton](https://twitter.com/jjeaton), [Ulrich Pogson](https://twitter.com/grapplerulrich), and [Brad Vincent](https://twitter.com/themergency). @@ -133,4 +133,4 @@ The homepage is based on a design as provided by [HTML5Up](http://html5up.net), ## Documentation, FAQs, and More -Because this version is a major rewrite of the core plugin, we’re working to create an entire site around the Boilerplate. If you’re interested, please [let me know](http://tommcfarlin.com/contact) and we’ll see what we can do. +Because this version is a major rewrite of the core plugin, we’re working to create an entire site around the Boilerplate. If you’re interested, please [let me know](http://devinvinson.com/contact/) and we’ll see what we can do.