From 373531d393d0235a4612d27a46ece0decd420dfe Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 09:46:06 -0400 Subject: [PATCH 01/11] renaming 'plugin-boilerplate' to 'plugin-name' to be more consistent with the naming conventions of the class file related #48 --- {plugin-boilerplate => plugin-name}/LICENSE.txt | 0 {plugin-boilerplate => plugin-name}/README.txt | 0 .../assets/banner-1544x500.png | Bin .../assets/banner-772x250.png | Bin .../class-plugin-boilerplate.php | 0 {plugin-boilerplate => plugin-name}/css/admin.css | 0 {plugin-boilerplate => plugin-name}/css/display.css | 0 {plugin-boilerplate => plugin-name}/js/admin.js | 0 {plugin-boilerplate => plugin-name}/js/display.js | 0 .../lang/plugin-boilerplate.pot | 0 .../plugin-boilerplate.php | 0 .../screenshot-1.png | Bin {plugin-boilerplate => plugin-name}/uninstall.php | 0 {plugin-boilerplate => plugin-name}/views/admin.php | 0 .../views/display.php | 0 15 files changed, 0 insertions(+), 0 deletions(-) rename {plugin-boilerplate => plugin-name}/LICENSE.txt (100%) rename {plugin-boilerplate => plugin-name}/README.txt (100%) rename {plugin-boilerplate => plugin-name}/assets/banner-1544x500.png (100%) rename {plugin-boilerplate => plugin-name}/assets/banner-772x250.png (100%) rename {plugin-boilerplate => plugin-name}/class-plugin-boilerplate.php (100%) rename {plugin-boilerplate => plugin-name}/css/admin.css (100%) rename {plugin-boilerplate => plugin-name}/css/display.css (100%) rename {plugin-boilerplate => plugin-name}/js/admin.js (100%) rename {plugin-boilerplate => plugin-name}/js/display.js (100%) rename {plugin-boilerplate => plugin-name}/lang/plugin-boilerplate.pot (100%) rename {plugin-boilerplate => plugin-name}/plugin-boilerplate.php (100%) rename {plugin-boilerplate => plugin-name}/screenshot-1.png (100%) rename {plugin-boilerplate => plugin-name}/uninstall.php (100%) rename {plugin-boilerplate => plugin-name}/views/admin.php (100%) rename {plugin-boilerplate => plugin-name}/views/display.php (100%) diff --git a/plugin-boilerplate/LICENSE.txt b/plugin-name/LICENSE.txt similarity index 100% rename from plugin-boilerplate/LICENSE.txt rename to plugin-name/LICENSE.txt diff --git a/plugin-boilerplate/README.txt b/plugin-name/README.txt similarity index 100% rename from plugin-boilerplate/README.txt rename to plugin-name/README.txt diff --git a/plugin-boilerplate/assets/banner-1544x500.png b/plugin-name/assets/banner-1544x500.png similarity index 100% rename from plugin-boilerplate/assets/banner-1544x500.png rename to plugin-name/assets/banner-1544x500.png diff --git a/plugin-boilerplate/assets/banner-772x250.png b/plugin-name/assets/banner-772x250.png similarity index 100% rename from plugin-boilerplate/assets/banner-772x250.png rename to plugin-name/assets/banner-772x250.png diff --git a/plugin-boilerplate/class-plugin-boilerplate.php b/plugin-name/class-plugin-boilerplate.php similarity index 100% rename from plugin-boilerplate/class-plugin-boilerplate.php rename to plugin-name/class-plugin-boilerplate.php diff --git a/plugin-boilerplate/css/admin.css b/plugin-name/css/admin.css similarity index 100% rename from plugin-boilerplate/css/admin.css rename to plugin-name/css/admin.css diff --git a/plugin-boilerplate/css/display.css b/plugin-name/css/display.css similarity index 100% rename from plugin-boilerplate/css/display.css rename to plugin-name/css/display.css diff --git a/plugin-boilerplate/js/admin.js b/plugin-name/js/admin.js similarity index 100% rename from plugin-boilerplate/js/admin.js rename to plugin-name/js/admin.js diff --git a/plugin-boilerplate/js/display.js b/plugin-name/js/display.js similarity index 100% rename from plugin-boilerplate/js/display.js rename to plugin-name/js/display.js diff --git a/plugin-boilerplate/lang/plugin-boilerplate.pot b/plugin-name/lang/plugin-boilerplate.pot similarity index 100% rename from plugin-boilerplate/lang/plugin-boilerplate.pot rename to plugin-name/lang/plugin-boilerplate.pot diff --git a/plugin-boilerplate/plugin-boilerplate.php b/plugin-name/plugin-boilerplate.php similarity index 100% rename from plugin-boilerplate/plugin-boilerplate.php rename to plugin-name/plugin-boilerplate.php diff --git a/plugin-boilerplate/screenshot-1.png b/plugin-name/screenshot-1.png similarity index 100% rename from plugin-boilerplate/screenshot-1.png rename to plugin-name/screenshot-1.png diff --git a/plugin-boilerplate/uninstall.php b/plugin-name/uninstall.php similarity index 100% rename from plugin-boilerplate/uninstall.php rename to plugin-name/uninstall.php diff --git a/plugin-boilerplate/views/admin.php b/plugin-name/views/admin.php similarity index 100% rename from plugin-boilerplate/views/admin.php rename to plugin-name/views/admin.php diff --git a/plugin-boilerplate/views/display.php b/plugin-name/views/display.php similarity index 100% rename from plugin-boilerplate/views/display.php rename to plugin-name/views/display.php From 39abb6e2dcd691fdde9117ae18bbdc2b5d1c23e0 Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 09:47:33 -0400 Subject: [PATCH 02/11] renaming files to be more consistent with the example name of the plugin related #48 --- .../{class-plugin-boilerplate.php => class-plugin-name.php} | 0 plugin-name/{plugin-boilerplate.php => plugin-name.php} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename plugin-name/{class-plugin-boilerplate.php => class-plugin-name.php} (100%) rename plugin-name/{plugin-boilerplate.php => plugin-name.php} (100%) diff --git a/plugin-name/class-plugin-boilerplate.php b/plugin-name/class-plugin-name.php similarity index 100% rename from plugin-name/class-plugin-boilerplate.php rename to plugin-name/class-plugin-name.php diff --git a/plugin-name/plugin-boilerplate.php b/plugin-name/plugin-name.php similarity index 100% rename from plugin-name/plugin-boilerplate.php rename to plugin-name/plugin-name.php From a289b607a3c02549ba5b285a3c74e4c999b42f4a Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 10:00:07 -0400 Subject: [PATCH 03/11] updating code comments, clearing extraneous whitespace related #48 --- plugin-name/class-plugin-name.php | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/plugin-name/class-plugin-name.php b/plugin-name/class-plugin-name.php index 2a34966..e6446fe 100644 --- a/plugin-name/class-plugin-name.php +++ b/plugin-name/class-plugin-name.php @@ -71,17 +71,18 @@ class PluginName { // Add the options page and menu item. // add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) ); - // Enqueue admin styles and scripts. + // Load admin stylesheets and JavaScript. add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) ); add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) ); - // Enqueue public style and scripts. + // Load public-facing stylesheets and JavaScript. add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_styles' ) ); add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) ); - // Define custom functionality. See http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters + // Define custom functionality. Read more about actions and filters: http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters add_action( 'TODO', array( $this, 'action_method_name' ) ); add_filter( 'TODO', array( $this, 'filter_method_name' ) ); + } /** @@ -136,7 +137,7 @@ class PluginName { } /** - * Enqueue admin-specific style sheets. + * Register and enqueue admin-specific stylesheets. * * @since 1.0.0 * @@ -156,7 +157,7 @@ class PluginName { } /** - * Enqueue admin-specific JavaScript. + * Register and enqueue admin-specific JavaScript. * * @since 1.0.0 * @@ -176,7 +177,7 @@ class PluginName { } /** - * Enqueue public-facing style sheets. + * Register and enqueue public-facing stylesheets. * * @since 1.0.0 */ @@ -185,7 +186,7 @@ class PluginName { } /** - * Enqueues public-facing script files. + * Register and enqueues public-facing JavaScript files. * * @since 1.0.0 */ @@ -199,6 +200,7 @@ class PluginName { * @since 1.0.0 */ public function add_plugin_admin_menu() { + /* * TODO: * @@ -213,6 +215,7 @@ class PluginName { $this->plugin_slug, array( $this, 'display_plugin_admin_page' ) ); + } /** @@ -249,4 +252,5 @@ class PluginName { public function filter_method_name() { // TODO: Define your filter hook callback here } + } \ No newline at end of file From cf9fdceac35b296335e3db296f7bcc374628f94e Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 10:00:38 -0400 Subject: [PATCH 04/11] changing what happens when the plugin is accessed directly related #48 --- plugin-name/plugin-name.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugin-name/plugin-name.php b/plugin-name/plugin-name.php index c002f0a..a573b95 100644 --- a/plugin-name/plugin-name.php +++ b/plugin-name/plugin-name.php @@ -25,8 +25,8 @@ */ // If this file is called directly, abort. -if ( ! defined( 'ABSPATH' ) ) { - exit; +if ( ! defined( 'WPINC' ) ) { + die; } // TODO: replace `class-plugin-boilerplate.php` with the name of the actual plugin's class file From 5cf899c20bd4db8f519f37d38db647135e419e0c Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 10:02:10 -0400 Subject: [PATCH 05/11] updating references in comments and in code to the plugin class files and plugin files related #48 --- plugin-name/class-plugin-name.php | 1 + plugin-name/plugin-name.php | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/plugin-name/class-plugin-name.php b/plugin-name/class-plugin-name.php index e6446fe..68ee6a3 100644 --- a/plugin-name/class-plugin-name.php +++ b/plugin-name/class-plugin-name.php @@ -93,6 +93,7 @@ class PluginName { * @return object A single instance of this class. */ public static function get_instance() { + // If the single instance hasn't been set, set it now. if ( null == self::$instance ) { self::$instance = new self; diff --git a/plugin-name/plugin-name.php b/plugin-name/plugin-name.php index a573b95..38d440e 100644 --- a/plugin-name/plugin-name.php +++ b/plugin-name/plugin-name.php @@ -29,13 +29,13 @@ if ( ! defined( 'WPINC' ) ) { die; } -// TODO: replace `class-plugin-boilerplate.php` with the name of the actual plugin's class file -require_once( plugin_dir_path( __FILE__ ) . 'class-plugin-boilerplate.php' ); +// TODO: replace `class-plugin-name.php` with the name of the actual plugin's class file +require_once( plugin_dir_path( __FILE__ ) . 'class-plugin-name.php' ); // Register hooks that are fired when the plugin is activated, deactivated, and uninstalled, respectively. -// TODO: replace PluginName with the name of the plugin defined in `class-plugin-boilerplate.php` +// TODO: replace PluginName with the name of the plugin defined in `class-plugin-name.php` register_activation_hook( __FILE__, array( 'PluginName', 'activate' ) ); register_deactivation_hook( __FILE__, array( 'PluginName', 'deactivate' ) ); -// TODO: replace PluginName with the name of the plugin defined in `class-plugin-boilerplate.php` +// TODO: replace PluginName with the name of the plugin defined in `class-plugin-name.php` PluginName::get_instance(); \ No newline at end of file From bf175250931b2fbcb406a6153bfaf92001bc6fe7 Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 10:11:56 -0400 Subject: [PATCH 06/11] renaming all 'display*' files to 'public*' files related #48 --- plugin-name/css/{display.css => public.css} | 0 plugin-name/js/{display.js => public.js} | 0 plugin-name/views/{display.php => public.php} | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename plugin-name/css/{display.css => public.css} (100%) rename plugin-name/js/{display.js => public.js} (100%) rename plugin-name/views/{display.php => public.php} (100%) diff --git a/plugin-name/css/display.css b/plugin-name/css/public.css similarity index 100% rename from plugin-name/css/display.css rename to plugin-name/css/public.css diff --git a/plugin-name/js/display.js b/plugin-name/js/public.js similarity index 100% rename from plugin-name/js/display.js rename to plugin-name/js/public.js diff --git a/plugin-name/views/display.php b/plugin-name/views/public.php similarity index 100% rename from plugin-name/views/display.php rename to plugin-name/views/public.php From 0154512f692ae6bc6d4149fb04cd4809b7d0aa36 Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 10:12:11 -0400 Subject: [PATCH 07/11] removing whitespace related #48 --- plugin-name/class-plugin-name.php | 1 + 1 file changed, 1 insertion(+) diff --git a/plugin-name/class-plugin-name.php b/plugin-name/class-plugin-name.php index 68ee6a3..bbcc2dc 100644 --- a/plugin-name/class-plugin-name.php +++ b/plugin-name/class-plugin-name.php @@ -130,6 +130,7 @@ class PluginName { * @since 1.0.0 */ public function load_plugin_textdomain() { + $domain = $this->plugin_slug; $locale = apply_filters( 'plugin_locale', get_locale(), $domain ); From 6f39dbc677d37dbd679ce9fe4af5a9ccc2ff0475 Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 10:13:11 -0400 Subject: [PATCH 08/11] since we're loading a single style sheet, using the singular form of the term related #48 --- plugin-name/class-plugin-name.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/plugin-name/class-plugin-name.php b/plugin-name/class-plugin-name.php index bbcc2dc..3e88f30 100644 --- a/plugin-name/class-plugin-name.php +++ b/plugin-name/class-plugin-name.php @@ -71,11 +71,11 @@ class PluginName { // Add the options page and menu item. // add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) ); - // Load admin stylesheets and JavaScript. + // Load admin style sheet and JavaScript. add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) ); add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) ); - // Load public-facing stylesheets and JavaScript. + // Load public-facing style sheet and JavaScript. add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_styles' ) ); add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) ); @@ -139,7 +139,7 @@ class PluginName { } /** - * Register and enqueue admin-specific stylesheets. + * Register and enqueue admin-specific style sheet. * * @since 1.0.0 * @@ -179,7 +179,7 @@ class PluginName { } /** - * Register and enqueue public-facing stylesheets. + * Register and enqueue public-facing style sheet. * * @since 1.0.0 */ From 9149ea7b17a2819dd62578bdf164094de26085ec Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 10:15:14 -0400 Subject: [PATCH 09/11] renaming and updating references in the pot file related #48 --- .../lang/{plugin-boilerplate.pot => plugin-name.pot} | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) rename plugin-name/lang/{plugin-boilerplate.pot => plugin-name.pot} (80%) diff --git a/plugin-name/lang/plugin-boilerplate.pot b/plugin-name/lang/plugin-name.pot similarity index 80% rename from plugin-name/lang/plugin-boilerplate.pot rename to plugin-name/lang/plugin-name.pot index b053730..d4b9bef 100644 --- a/plugin-name/lang/plugin-boilerplate.pot +++ b/plugin-name/lang/plugin-name.pot @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: TODO 1.0.0\n" -"Report-Msgid-Bugs-To: http://wordpress.org/tag/plugin-boilerplate\n" +"Report-Msgid-Bugs-To: http://wordpress.org/tag/plugin-name\n" "POT-Creation-Date: 2013-05-10 11:23:19+00:00\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -18,18 +18,18 @@ msgstr "" "Plural-Forms: nplurals=2; plural=n != 1;\n" "X-Poedit-SearchPath-0: .\n" -#: plugin-boilerplate.php:273 +#: plugin-name.php:273 msgid "Page Title" msgstr "" -#: plugin-boilerplate.php:274 +#: plugin-name.php:274 msgid "Menu Text" msgstr "" -#: plugin-boilerplate.php:275 +#: plugin-name.php:275 msgid "read" msgstr "" -#: plugin-boilerplate.php:276 +#: plugin-name.php:276 msgid "plugin-name" msgstr "" \ No newline at end of file From d5fe812b83ea24fdeca4ac123d83040710043b8d Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 10:16:38 -0400 Subject: [PATCH 10/11] removing author email tag and lining up terms related #48 --- plugin-name/plugin-name.php | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/plugin-name/plugin-name.php b/plugin-name/plugin-name.php index 38d440e..302689f 100644 --- a/plugin-name/plugin-name.php +++ b/plugin-name/plugin-name.php @@ -12,14 +12,13 @@ * * @wordpress-plugin * Plugin Name: TODO - * Plugin URI: TODO + * Plugin URI: TODO * Description: TODO - * Version: 1.0.0 - * Author: TODO - * Author URI: TODO - * Author Email: TODO + * Version: 1.0.0 + * Author: TODO + * Author URI: TODO * Text Domain: plugin-name-locale - * License: GPL-2.0+ + * License: GPL-2.0+ * License URI: http://www.gnu.org/licenses/gpl-2.0.txt * Domain Path: /lang/ */ From 0d968d2c20af65ca9b1005aa036d7de8aaccbb74 Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 15 May 2013 10:18:02 -0400 Subject: [PATCH 11/11] removing a trailing / related #48 --- plugin-name/plugin-name.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin-name/plugin-name.php b/plugin-name/plugin-name.php index 302689f..256295c 100644 --- a/plugin-name/plugin-name.php +++ b/plugin-name/plugin-name.php @@ -20,7 +20,7 @@ * Text Domain: plugin-name-locale * License: GPL-2.0+ * License URI: http://www.gnu.org/licenses/gpl-2.0.txt - * Domain Path: /lang/ + * Domain Path: /lang */ // If this file is called directly, abort.