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

properly adding tabs and spaces

Browse source 
fixes #44
This commit is contained in:
Tom McFarlin 2013-05-12 10:12:50 -04:00
parent d5d2579594
commit 347b63c876
3 changed files with 210 additions and 210 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

416
plugin-boilerplate/class-plugin-boilerplate.php
View file

@ -36,260 +36,260 @@ if ( ! defined( 'ABSPATH' ) ) {
// TODO: Replace 'PLUGIN_NAME' wih the name of your class // TODO: Replace 'PLUGIN_NAME' wih the name of your class
if ( ! defined( 'PLUGIN_NAME_VERSION' ) ) { if ( ! defined( 'PLUGIN_NAME_VERSION' ) ) {
// TODO: Make sure that this version correspondings to the value in the 'Version' in the header // TODO: Make sure that this version correspondings to the value in the 'Version' in the header
define( 'PLUGIN_NAME_VERSION', '1.0.0' ); define( 'PLUGIN_NAME_VERSION', '1.0.0' );
} }
// TODO: Rename this class to a proper name for your plugin. // TODO: Rename this class to a proper name for your plugin.
class PluginName { class PluginName {
/** /**
* Refers to a single instance of this class. * Refers to a single instance of this class.
* *
* @var object * @var object
*/ */
protected static $instance = null; protected static $instance = null;
/** /**
* Refers to the slug of the plugin screen. * Refers to the slug of the plugin screen.
* *
* @var string * @var string
*/ */
protected $plugin_screen_slug = null; protected $plugin_screen_slug = null;
/** /**
* Creates or returns an instance of this class. * Creates or returns an instance of this class.
* *
* @since 1.0.0 * @since 1.0.0
* @return PluginName A single instance of this class. * @return PluginName A single instance of this class.
*/ */
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;
} }
return self::$instance; return self::$instance;
} }
/** /**
* Initializes the plugin by setting localization, filters, and administration functions. * Initializes the plugin by setting localization, filters, and administration functions.
* *
* @since 1.0.0 * @since 1.0.0
*/ */
private function __construct() { private function __construct() {
// Load plugin text domain // Load plugin text domain
add_action( 'init', array( $this, 'load_plugin_textdomain' ) ); add_action( 'init', array( $this, 'load_plugin_textdomain' ) );
/* /*
* Add the options page and menu item. * Add the options page and menu item.
* Uncomment the following line to enable the Settings Page for the plugin: * Uncomment the following line to enable the Settings Page for the plugin:
*/ */
//add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) ); //add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) );
/* /*
* Register admin styles and scripts * Register admin styles and scripts
* If the Settings page has been activated using the above hook, the scripts and styles * 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 * will only be loaded on the settings page. If not, they will be loaded for all
* admin pages. * admin pages.
* *
* add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_styles' ) ); * add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_styles' ) );
* add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_scripts' ) ); * add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_scripts' ) );
*/ */
// Register site stylesheets and JavaScript // Register site stylesheets and JavaScript
add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_styles' ) ); add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_styles' ) );
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' ) );
/* /*
* TODO: * TODO:
* *
* Define the custom functionality for your plugin. The first parameter of the * 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. * 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 * The second parameter is the function name located within this class. See the stubs
* later in the file. * later in the file.
* *
* For more information: * For more information:
* 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' ) );
} }
/** /**
* Fired when the plugin is activated. * 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 ) { public function activate( $network_wide ) {
// TODO: Define activation functionality here // TODO: Define activation functionality here
} }
/** /**
* Fired when the plugin is deactivated. * 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
* @since 1.0.0 * @since 1.0.0
*/ */
public function deactivate( $network_wide ) { public function deactivate( $network_wide ) {
// TODO: Define deactivation functionality here // TODO: Define deactivation functionality here
} }
/** /**
* Loads the plugin text domain for translation * Loads the plugin text domain for translation
*/ */
public function load_plugin_textdomain() { public function load_plugin_textdomain() {
// TODO: replace "plugin-name-locale" with a unique value for your plugin // TODO: replace "plugin-name-locale" with a unique value for your plugin
$domain = 'plugin-name-locale'; $domain = 'plugin-name-locale';
$locale = apply_filters( 'plugin_locale', get_locale(), $domain ); $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
load_textdomain( $domain, WP_LANG_DIR . '/' . $domain . '/' . $domain . '-' . $locale . '.mo' ); load_textdomain( $domain, WP_LANG_DIR . '/' . $domain . '/' . $domain . '-' . $locale . '.mo' );
load_plugin_textdomain( $domain, FALSE, dirname( plugin_basename( __FILE__ ) ) . '/lang/' ); load_plugin_textdomain( $domain, FALSE, dirname( plugin_basename( __FILE__ ) ) . '/lang/' );
} }
/** /**
* Registers and enqueues admin-specific styles. * Registers and enqueues admin-specific styles.
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function register_admin_styles() { public function register_admin_styles() {
/* /*
* Check if the plugin has registered a settings page * Check if the plugin has registered a settings page
* 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
* Don't enqueue stylesheet or JavaScript if it's not * Don't enqueue stylesheet or JavaScript if it's not
*/ */
$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__ ), PLUGIN_NAME_VERSION ); wp_enqueue_style( 'plugin-name-admin-styles', plugins_url( 'css/admin.css', __FILE__ ), PLUGIN_NAME_VERSION );
} }
} }
} }
/** /**
* Registers and enqueues admin-specific JavaScript. * Registers and enqueues admin-specific JavaScript.
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function register_admin_scripts() { public function register_admin_scripts() {
/* /*
* Check if the plugin has registered a settings page * Check if the plugin has registered a settings page
* 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
* Don't enqueue stylesheet or JavaScript if it's not * Don't enqueue stylesheet or JavaScript if it's not
*/ */
$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' ), PLUGIN_NAME_VERSION ); wp_enqueue_script( 'plugin-name-admin-script', plugins_url('js/admin.js', __FILE__), array( 'jquery' ), PLUGIN_NAME_VERSION );
} }
} }
} }
/** /**
* Registers and enqueues public-facing stylesheets. * 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__ ), PLUGIN_NAME_VERSION ); wp_enqueue_style( 'plugin-name-plugin-styles', plugins_url( 'css/display.css', __FILE__ ), PLUGIN_NAME_VERSION );
} }
/** /**
* Registers and enqueues public-facing JavaScript. * 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' ), PLUGIN_NAME_VERSION ); wp_enqueue_script( 'plugin-name-plugin-script', plugins_url( 'js/display.js', __FILE__ ), array( 'jquery' ), PLUGIN_NAME_VERSION );
} }
/** /**
* Registers the administration menu for this plugin into the WordPress Dashboard menu. * Registers the administration menu for this plugin into the WordPress Dashboard menu.
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function add_plugin_admin_menu() { public function add_plugin_admin_menu() {
/* /*
* TODO: * TODO:
* *
* Change 'Page Title' to the title of your plugin admin page * 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 'Menu Text' to the text for menu item for the plugin settings page
* 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', 'read',
'plugin-name', 'plugin-name',
array( $this, 'display_plugin_admin_page' ) array( $this, 'display_plugin_admin_page' )
); );
} }
/** /**
* Renders the options page for this plugin. * Renders the options page for this plugin.
* *
* @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');
} }
/* /*
* NOTE: Actions are points in the execution of a page or process * NOTE: Actions are points in the execution of a page or process
* lifecycle that WordPress fires. * lifecycle that WordPress fires.
* *
* WordPress Actions: http://codex.wordpress.org/Plugin_API#Actions * WordPress Actions: http://codex.wordpress.org/Plugin_API#Actions
* Action Reference: http://codex.wordpress.org/Plugin_API/Action_Reference * Action Reference: http://codex.wordpress.org/Plugin_API/Action_Reference
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function action_method_name() { public function action_method_name() {
// TODO: Define your action method here // TODO: Define your action method here
} }
/* /*
* NOTE: Filters are points of execution in which WordPress modifies data * NOTE: Filters are points of execution in which WordPress modifies data
* before saving it or sending it to the browser. * before saving it or sending it to the browser.
* *
* WordPress Filters: http://codex.wordpress.org/Plugin_API#Filters * WordPress Filters: http://codex.wordpress.org/Plugin_API#Filters
* Filter Reference: http://codex.wordpress.org/Plugin_API/Filter_Reference * Filter Reference: http://codex.wordpress.org/Plugin_API/Filter_Reference
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function filter_method_name() { public function filter_method_name() {
// TODO: Define your filter method here // TODO: Define your filter method here
} }
} }

2
plugin-boilerplate/plugin-boilerplate.php
View file

@ -32,7 +32,7 @@
* that request data directly. * that request data directly.
*/ */
if ( ! defined( 'ABSPATH' ) ) { if ( ! defined( 'ABSPATH' ) ) {
exit; exit;
} }
require_once( plugin_dir_path( __FILE__ ) . 'class-plugin-boilerplate.php' ); require_once( plugin_dir_path( __FILE__ ) . 'class-plugin-boilerplate.php' );

2
plugin-boilerplate/uninstall.php
View file

@ -12,7 +12,7 @@
// If uninstall, not called from WordPress, then exit // If uninstall, not called from WordPress, then exit
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) { if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
exit(); exit;
} }
// TODO: Define uninstall functionality here // TODO: Define uninstall functionality here