inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-23 04:13:53 +02:00
Code Issues Releases Wiki Activity

updating the php code formatting

Browse source 
related #38
This commit is contained in:
Tom McFarlin 2013-05-09 22:05:29 -04:00
parent 626a161581
commit 791920143e
1 changed files with 288 additions and 270 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
plugin-boilerplate/plugin.php
View file

@ -9,23 +9,39 @@ Author URI: TODO
Author Email: TODO Author Email: TODO
License: 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 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. published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details. GNU General Public License for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 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: * TODO:
* *
@ -45,6 +61,7 @@ class PluginName {
/** /**
* Refers to a single instance of this class. * Refers to a single instance of this class.
*
* @access private * @access private
* @var object * @var object
*/ */
@ -52,6 +69,7 @@ class PluginName {
/** /**
* Refers to the slug of the plugin screen. * Refers to the slug of the plugin screen.
*
* @access private * @access private
* @var string * @var string
*/ */
@ -70,7 +88,7 @@ class PluginName {
public function get_instance() { public function get_instance() {
// If the single instance hasn't been set, set it now. // If the single instance hasn't been set, set it now.
if( null == self::$instance ) { if ( null == self::$instance ) {
self::$instance = new self; self::$instance = new self;
} // end if } // end if
@ -109,7 +127,7 @@ class PluginName {
add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_scripts' ) ); 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 hooks that are fired when the plugin is activated, deactivated, and uninstalled, respectively.
register_activation_hook( __FILE__, array( $this, 'activate' ) ); register_activation_hook(__FILE__, array( $this, 'activate' ) );
register_deactivation_hook( __FILE__, array( $this, 'deactivate' ) ); register_deactivation_hook( __FILE__, array( $this, 'deactivate' ) );
/* /*
@ -125,7 +143,7 @@ class PluginName {
* http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters * http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters
*/ */
add_action( 'TODO', array( $this, 'action_method_name' ) ); add_action( 'TODO', array( $this, 'action_method_name' ) );
add_filter( 'TODO', array( $this, 'filter_method_name' ) ); add_filter(' TODO', array( $this, 'filter_method_name' ) );
} // end constructor } // end constructor
@ -174,7 +192,7 @@ class PluginName {
* and if it has, make sure only to enqueue the scripts on the relevant screens * and if it has, make sure only to enqueue the scripts on the relevant screens
*/ */
if ( isset( $this->plugin_screen_slug ) ){ if ( isset( $this->plugin_screen_slug ) ) {
/* /*
* Check if current screen is the admin page for this plugin * Check if current screen is the admin page for this plugin
@ -183,7 +201,7 @@ class PluginName {
$screen = get_current_screen(); $screen = get_current_screen();
if ( $screen->id == $this->plugin_screen_slug ) { if ( $screen->id == $this->plugin_screen_slug ) {
wp_enqueue_style( 'plugin-name-admin-styles', plugins_url( 'css/admin.css', __FILE__ ) ); wp_enqueue_style( 'plugin-name-admin-styles', plugins_url( 'css/admin.css', __FILE__ ), PLUGIN_NAME_VERSION );
} // end if } // end if
} // end if } // end if
@ -202,7 +220,7 @@ class PluginName {
* and if it has, make sure only to enqueue the scripts on the relevant screens * and if it has, make sure only to enqueue the scripts on the relevant screens
*/ */
if ( isset( $this->plugin_screen_slug ) ){ if ( isset( $this->plugin_screen_slug ) ) {
/* /*
* Check if current screen is the admin page for this plugin * Check if current screen is the admin page for this plugin
@ -211,7 +229,7 @@ class PluginName {
$screen = get_current_screen(); $screen = get_current_screen();
if ( $screen->id == $this->plugin_screen_slug ) { if ( $screen->id == $this->plugin_screen_slug ) {
wp_enqueue_script( 'plugin-name-admin-script', plugins_url( 'js/admin.js', __FILE__ ), array( 'jquery' ) ); wp_enqueue_script( 'plugin-name-admin-script', plugins_url('js/admin.js', __FILE__), array( 'jquery' ), PLUGIN_NAME_VERSION );
} // end if } // end if
} // end if } // end if
@ -219,21 +237,21 @@ class PluginName {
} // end register_admin_scripts } // end register_admin_scripts
/** /**
* Registers and enqueues plugin-specific styles. * Registers and enqueues public-facing stylesheets.
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function register_plugin_styles() { public function register_plugin_styles() {
wp_enqueue_style( 'plugin-name-plugin-styles', plugins_url( 'css/display.css', __FILE__ ) ); wp_enqueue_style( 'plugin-name-plugin-styles', plugins_url( 'css/display.css', __FILE__ ), PLUGIN_NAME_VERSION );
} // end register_plugin_styles } // end register_plugin_styles
/** /**
* Registers and enqueues plugin-specific scripts. * Registers and enqueues public-facing JavaScript.
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function register_plugin_scripts() { public function register_plugin_scripts() {
wp_enqueue_script( 'plugin-name-plugin-script', plugins_url( 'js/display.js', __FILE__ ), array( 'jquery' ) ); wp_enqueue_script( 'plugin-name-plugin-script', plugins_url( 'js/display.js', __FILE__ ), array( 'jquery' ), PLUGIN_NAME_VERSION );
} // end register_plugin_scripts } // end register_plugin_scripts
/** /**
@ -251,10 +269,10 @@ class PluginName {
* Change 'plugin-name' to the name of your plugin * Change 'plugin-name' to the name of your plugin
*/ */
$this->plugin_screen_slug = add_plugins_page( $this->plugin_screen_slug = add_plugins_page(
__( 'Page Title', 'plugin-name-locale' ), __('Page Title', 'plugin-name-locale'),
__( 'Menu Text', 'plugin-name-locale' ), __('Menu Text', 'plugin-name-locale'),
__( 'read', 'plugin-name-locale' ), __('read', 'plugin-name-locale'),
__( 'plugin-name', 'plugin-name-locale' ), __('plugin-name', 'plugin-name-locale'),
array( $this, 'display_plugin_admin_page' ) array( $this, 'display_plugin_admin_page' )
); );
@ -266,7 +284,7 @@ class PluginName {
* @since 1.0.0 * @since 1.0.0
*/ */
public function display_plugin_admin_page() { public function display_plugin_admin_page() {
include_once( 'views/admin.php' ); include_once('views/admin.php');
} // end add_plugin_admin_page } // end add_plugin_admin_page
/*--------------------------------------------* /*--------------------------------------------*