diff --git a/plugin-boilerplate/plugin.php b/plugin-boilerplate/plugin.php index f26d0ff..75c9fd8 100644 --- a/plugin-boilerplate/plugin.php +++ b/plugin-boilerplate/plugin.php @@ -12,7 +12,7 @@ License: Copyright 2013 TODO (email@domain.com) 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 + 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, @@ -23,37 +23,37 @@ License: 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 - + */ // TODO: rename this class to a proper name for your plugin class PluginName { - + /*--------------------------------------------* * Constructor *--------------------------------------------*/ - + /** * Initializes the plugin by setting localization, filters, and administration functions. */ function __construct() { - + // Load plugin text domain add_action( 'init', array( $this, 'plugin_textdomain' ) ); // Register admin styles and scripts add_action( 'admin_print_styles', array( $this, 'register_admin_styles' ) ); add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_scripts' ) ); - + // Register site styles and scripts add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_styles' ) ); add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_scripts' ) ); - + // Register hooks that are fired when the plugin is activated, deactivated, and uninstalled, respectively. register_activation_hook( __FILE__, array( $this, 'activate' ) ); register_deactivation_hook( __FILE__, array( $this, 'deactivate' ) ); register_uninstall_hook( __FILE__, array( $this, 'uninstall' ) ); - + /* * TODO: * Define the custom functionality for your plugin. The first parameter of the @@ -62,46 +62,46 @@ class PluginName { * The second parameter is the function name located within this class. See the stubs * later in the file. * - * For more information: + * For more information: * 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' ) ); } // end constructor - + /** * Fired when the plugin is activated. * - * @param boolean $network_wide True if WPMU superadmin uses "Network Activate" action, false if WPMU is disabled or plugin is activated on an individual blog + * @param boolean $network_wide True if WPMU superadmin uses "Network Activate" action, false if WPMU is disabled or plugin is activated on an individual blog */ public function activate( $network_wide ) { // TODO: Define activation functionality here } // end activate - + /** * Fired when the plugin is deactivated. * - * @param boolean $network_wide True if WPMU superadmin uses "Network Activate" action, false if WPMU is disabled or plugin is activated on an individual blog + * @param boolean $network_wide True if WPMU superadmin uses "Network Activate" action, false if WPMU is disabled or plugin is activated on an individual blog */ public function deactivate( $network_wide ) { - // TODO: Define deactivation functionality here + // TODO: Define deactivation functionality here } // end deactivate - + /** * Fired when the plugin is uninstalled. * - * @param boolean $network_wide True if WPMU superadmin uses "Network Activate" action, false if WPMU is disabled or plugin is activated on an individual blog + * @param boolean $network_wide True if WPMU superadmin uses "Network Activate" action, false if WPMU is disabled or plugin is activated on an individual blog */ public function uninstall( $network_wide ) { - // TODO: Define uninstall functionality here + // TODO: Define uninstall functionality here } // end uninstall /** * Loads the plugin text domain for translation */ public function plugin_textdomain() { - + // TODO: replace "plugin-name-locale" with a unique value for your plugin $domain = 'plugin-name-locale'; $locale = apply_filters( 'plugin_locale', get_locale(), $domain ); @@ -114,46 +114,46 @@ class PluginName { * Registers and enqueues admin-specific styles. */ public function register_admin_styles() { - + // TODO: Change 'plugin-name' to the name of your plugin wp_enqueue_style( 'plugin-name-admin-styles', plugins_url( 'plugin-name/css/admin.css' ) ); - + } // end register_admin_styles /** * Registers and enqueues admin-specific JavaScript. - */ + */ public function register_admin_scripts() { - + // TODO: Change 'plugin-name' to the name of your plugin - wp_enqueue_script( 'plugin-name-admin-script', plugins_url( 'plugin-name/js/admin.js' ) ); - + wp_enqueue_script( 'plugin-name-admin-script', plugins_url( 'plugin-name/js/admin.js' ), array('jquery') ); + } // end register_admin_scripts - + /** * Registers and enqueues plugin-specific styles. */ public function register_plugin_styles() { - + // TODO: Change 'plugin-name' to the name of your plugin wp_enqueue_style( 'plugin-name-plugin-styles', plugins_url( 'plugin-name/css/display.css' ) ); - + } // end register_plugin_styles - + /** * Registers and enqueues plugin-specific scripts. */ public function register_plugin_scripts() { - + // TODO: Change 'plugin-name' to the name of your plugin - wp_enqueue_script( 'plugin-name-plugin-script', plugins_url( 'plugin-name/js/display.js' ) ); - + wp_enqueue_script( 'plugin-name-plugin-script', plugins_url( 'plugin-name/js/display.js' ), array('jquery') ); + } // end register_plugin_scripts - + /*--------------------------------------------* * Core Functions *---------------------------------------------*/ - + /** * NOTE: Actions are points in the execution of a page or process * lifecycle that WordPress fires. @@ -165,7 +165,7 @@ class PluginName { function action_method_name() { // TODO: Define your action method here } // end action_method_name - + /** * NOTE: Filters are points of execution in which WordPress modifies data * before saving it or sending it to the browser. @@ -177,7 +177,7 @@ class PluginName { function filter_method_name() { // TODO: Define your filter method here } // end filter_method_name - + } // end class // TODO: Update the instantiation call of your plugin to the name given at the class definition