From 791920143ed772f291f7ce0690eeaccc198054b6 Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Thu, 9 May 2013 22:05:29 -0400 Subject: [PATCH] updating the php code formatting related #38 --- plugin-boilerplate/plugin.php | 558 ++++++++++++++++++---------------- 1 file changed, 288 insertions(+), 270 deletions(-) diff --git a/plugin-boilerplate/plugin.php b/plugin-boilerplate/plugin.php index bd88c52..cee1d14 100644 --- a/plugin-boilerplate/plugin.php +++ b/plugin-boilerplate/plugin.php @@ -9,23 +9,39 @@ Author URI: TODO Author Email: TODO License: - Copyright 2013 TODO (email@domain.com) +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 - published by the Free Software Foundation. +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. +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 +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 */ +/* + * The following constant is used to define a constant for this plugin to make it + * easier to provide cache-busting functionality on loading stylesheets + * and JavaScript. + * + * After you've defined these constants, do a find/replace on the constants + * used throughout the rest of this file. + */ +// TODO: Replace 'PLUGIN_NAME' wih the name of your class +if ( ! defined('PLUGIN_NAME_VERSION' ) ) { + + // TODO: Make sure that this version correspondings to the value in the 'Version' in the header + define( 'PLUGIN_NAME_VERSION', '1.0.0' ); + +} // end if + /** * TODO: * @@ -38,267 +54,269 @@ License: * @version 1.0.0 */ class PluginName { - - /*--------------------------------------------* - * Properties - *--------------------------------------------*/ - - /** - * Refers to a single instance of this class. - * @access private - * @var object - */ - private static $instance = null; - - /** - * Refers to the slug of the plugin screen. - * @access private - * @var string - */ - private $plugin_screen_slug = null; - - /*--------------------------------------------* - * Constructor - *--------------------------------------------*/ - - /** - * Creates or returns an instance of this class. - * - * @since 1.0.0 - * @return PluginName A single instance of this class. - */ - public function get_instance() { - - // If the single instance hasn't been set, set it now. - if( null == self::$instance ) { - self::$instance = new self; - } // end if - - return self::$instance; - - } // end get_instance; - - /** - * Initializes the plugin by setting localization, filters, and administration functions. - * - * @since 1.0.0 - */ - private function __construct() { - - // Load plugin text domain - add_action( 'init', array( $this, 'load_plugin_textdomain' ) ); - - /* - * Add the options page and menu item. - * Uncomment the following line to enable the Settings Page for the plugin: - */ - //add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) ); - - /* - * Register admin styles and scripts - * If the Settings page has been activated using the above hook, the scripts and styles - * will only be loaded on the settings page. If not, they will be loaded for all - * admin pages. - * - * add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_styles' ) ); - * add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_scripts' ) ); - */ - - // Register site stylesheets and JavaScript - 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' ) ); - - /* - * TODO: - * - * Define the custom functionality for your plugin. The first parameter of the - * add_action/add_filter calls are the hooks into which your code should fire. - * - * The second parameter is the function name located within this class. See the stubs - * later in the file. - * - * 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 - */ - 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 - * @since 1.0.0 - */ - public function deactivate( $network_wide ) { - // TODO: Define deactivation functionality here - } // end deactivate - - /** - * Loads the plugin text domain for translation - */ - public function load_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 ); - + + /*--------------------------------------------* + * Properties + *--------------------------------------------*/ + + /** + * Refers to a single instance of this class. + * + * @access private + * @var object + */ + private static $instance = null; + + /** + * Refers to the slug of the plugin screen. + * + * @access private + * @var string + */ + private $plugin_screen_slug = null; + + /*--------------------------------------------* + * Constructor + *--------------------------------------------*/ + + /** + * Creates or returns an instance of this class. + * + * @since 1.0.0 + * @return PluginName A single instance of this class. + */ + public function get_instance() { + + // If the single instance hasn't been set, set it now. + if ( null == self::$instance ) { + self::$instance = new self; + } // end if + + return self::$instance; + + } // end get_instance; + + /** + * Initializes the plugin by setting localization, filters, and administration functions. + * + * @since 1.0.0 + */ + private function __construct() { + + // Load plugin text domain + add_action( 'init', array( $this, 'load_plugin_textdomain' ) ); + + /* + * Add the options page and menu item. + * Uncomment the following line to enable the Settings Page for the plugin: + */ + //add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) ); + + /* + * Register admin styles and scripts + * If the Settings page has been activated using the above hook, the scripts and styles + * will only be loaded on the settings page. If not, they will be loaded for all + * admin pages. + * + * add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_styles' ) ); + * add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_scripts' ) ); + */ + + // Register site stylesheets and JavaScript + 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' ) ); + + /* + * TODO: + * + * Define the custom functionality for your plugin. The first parameter of the + * add_action/add_filter calls are the hooks into which your code should fire. + * + * The second parameter is the function name located within this class. See the stubs + * later in the file. + * + * 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 + */ + 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 + * @since 1.0.0 + */ + public function deactivate( $network_wide ) { + // TODO: Define deactivation functionality here + } // end deactivate + + /** + * Loads the plugin text domain for translation + */ + public function load_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 ); + load_textdomain( $domain, WP_LANG_DIR . '/' . $domain . '/' . $domain . '-' . $locale . '.mo' ); load_plugin_textdomain( $domain, FALSE, dirname( plugin_basename( __FILE__ ) ) . '/lang/' ); - - } // end load_plugin_textdomain - - /** - * Registers and enqueues admin-specific styles. - * - * @since 1.0.0 - */ - public function register_admin_styles() { - - /* - * Check if the plugin has registered a settings page - * and if it has, make sure only to enqueue the scripts on the relevant screens - */ - - if ( isset( $this->plugin_screen_slug ) ){ - - /* - * Check if current screen is the admin page for this plugin - * Don't enqueue stylesheet or JavaScript if it's not - */ - - $screen = get_current_screen(); - if ( $screen->id == $this->plugin_screen_slug ) { - wp_enqueue_style( 'plugin-name-admin-styles', plugins_url( 'css/admin.css', __FILE__ ) ); - } // end if - - } // end if - - } // end register_admin_styles - - /** - * Registers and enqueues admin-specific JavaScript. - * - * @since 1.0.0 - */ - public function register_admin_scripts() { - - /* - * Check if the plugin has registered a settings page - * and if it has, make sure only to enqueue the scripts on the relevant screens - */ - - if ( isset( $this->plugin_screen_slug ) ){ - - /* - * Check if current screen is the admin page for this plugin - * Don't enqueue stylesheet or JavaScript if it's not - */ - - $screen = get_current_screen(); - if ( $screen->id == $this->plugin_screen_slug ) { - wp_enqueue_script( 'plugin-name-admin-script', plugins_url( 'js/admin.js', __FILE__ ), array( 'jquery' ) ); - } // end if - - } // end if - - } // end register_admin_scripts - - /** - * Registers and enqueues plugin-specific styles. - * - * @since 1.0.0 - */ - public function register_plugin_styles() { - wp_enqueue_style( 'plugin-name-plugin-styles', plugins_url( 'css/display.css', __FILE__ ) ); - } // end register_plugin_styles - - /** - * Registers and enqueues plugin-specific scripts. - * - * @since 1.0.0 - */ - public function register_plugin_scripts() { - wp_enqueue_script( 'plugin-name-plugin-script', plugins_url( 'js/display.js', __FILE__ ), array( 'jquery' ) ); - } // end register_plugin_scripts - - /** - * Registers the administration menu for this plugin into the WordPress Dashboard menu. - * - * @since 1.0.0 - */ - public function add_plugin_admin_menu() { - - /* - * TODO: - * - * Change 'Page Title' to the title of your plugin admin page - * Change 'Menu Text' to the text for menu item for the plugin settings page - * Change 'plugin-name' to the name of your plugin - */ - $this->plugin_screen_slug = add_plugins_page( - __( 'Page Title', 'plugin-name-locale' ), - __( 'Menu Text', 'plugin-name-locale' ), - __( 'read', 'plugin-name-locale' ), - __( 'plugin-name', 'plugin-name-locale' ), - array( $this, 'display_plugin_admin_page' ) - ); - - } // end add_plugin_admin_menu - - /** - * Renders the options page for this plugin. - * - * @since 1.0.0 - */ - public function display_plugin_admin_page() { - include_once( 'views/admin.php' ); - } // end add_plugin_admin_page - - /*--------------------------------------------* - * Core Functions - *---------------------------------------------*/ - - /* - * NOTE: Actions are points in the execution of a page or process - * lifecycle that WordPress fires. - * - * WordPress Actions: http://codex.wordpress.org/Plugin_API#Actions - * Action Reference: http://codex.wordpress.org/Plugin_API/Action_Reference - * - * @since 1.0.0 - */ - public 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. - * - * WordPress Filters: http://codex.wordpress.org/Plugin_API#Filters - * Filter Reference: http://codex.wordpress.org/Plugin_API/Filter_Reference - * - * @since 1.0.0 - */ - public function filter_method_name() { - // TODO: Define your filter method here - } // end filter_method_name - + + } // end load_plugin_textdomain + + /** + * Registers and enqueues admin-specific styles. + * + * @since 1.0.0 + */ + public function register_admin_styles() { + + /* + * Check if the plugin has registered a settings page + * and if it has, make sure only to enqueue the scripts on the relevant screens + */ + + if ( isset( $this->plugin_screen_slug ) ) { + + /* + * Check if current screen is the admin page for this plugin + * Don't enqueue stylesheet or JavaScript if it's not + */ + + $screen = get_current_screen(); + if ( $screen->id == $this->plugin_screen_slug ) { + wp_enqueue_style( 'plugin-name-admin-styles', plugins_url( 'css/admin.css', __FILE__ ), PLUGIN_NAME_VERSION ); + } // end if + + } // end if + + } // end register_admin_styles + + /** + * Registers and enqueues admin-specific JavaScript. + * + * @since 1.0.0 + */ + public function register_admin_scripts() { + + /* + * Check if the plugin has registered a settings page + * and if it has, make sure only to enqueue the scripts on the relevant screens + */ + + if ( isset( $this->plugin_screen_slug ) ) { + + /* + * Check if current screen is the admin page for this plugin + * Don't enqueue stylesheet or JavaScript if it's not + */ + + $screen = get_current_screen(); + if ( $screen->id == $this->plugin_screen_slug ) { + wp_enqueue_script( 'plugin-name-admin-script', plugins_url('js/admin.js', __FILE__), array( 'jquery' ), PLUGIN_NAME_VERSION ); + } // end if + + } // end if + + } // end register_admin_scripts + + /** + * Registers and enqueues public-facing stylesheets. + * + * @since 1.0.0 + */ + public function register_plugin_styles() { + wp_enqueue_style( 'plugin-name-plugin-styles', plugins_url( 'css/display.css', __FILE__ ), PLUGIN_NAME_VERSION ); + } // end register_plugin_styles + + /** + * Registers and enqueues public-facing JavaScript. + * + * @since 1.0.0 + */ + public function register_plugin_scripts() { + wp_enqueue_script( 'plugin-name-plugin-script', plugins_url( 'js/display.js', __FILE__ ), array( 'jquery' ), PLUGIN_NAME_VERSION ); + } // end register_plugin_scripts + + /** + * Registers the administration menu for this plugin into the WordPress Dashboard menu. + * + * @since 1.0.0 + */ + public function add_plugin_admin_menu() { + + /* + * TODO: + * + * Change 'Page Title' to the title of your plugin admin page + * Change 'Menu Text' to the text for menu item for the plugin settings page + * Change 'plugin-name' to the name of your plugin + */ + $this->plugin_screen_slug = add_plugins_page( + __('Page Title', 'plugin-name-locale'), + __('Menu Text', 'plugin-name-locale'), + __('read', 'plugin-name-locale'), + __('plugin-name', 'plugin-name-locale'), + array( $this, 'display_plugin_admin_page' ) + ); + + } // end add_plugin_admin_menu + + /** + * Renders the options page for this plugin. + * + * @since 1.0.0 + */ + public function display_plugin_admin_page() { + include_once('views/admin.php'); + } // end add_plugin_admin_page + + /*--------------------------------------------* + * Core Functions + *---------------------------------------------*/ + + /* + * NOTE: Actions are points in the execution of a page or process + * lifecycle that WordPress fires. + * + * WordPress Actions: http://codex.wordpress.org/Plugin_API#Actions + * Action Reference: http://codex.wordpress.org/Plugin_API/Action_Reference + * + * @since 1.0.0 + */ + public 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. + * + * WordPress Filters: http://codex.wordpress.org/Plugin_API#Filters + * Filter Reference: http://codex.wordpress.org/Plugin_API/Filter_Reference + * + * @since 1.0.0 + */ + public 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