mirror of
https://github.com/inretio/WordPress-Plugin-Boilerplate
synced 2024-12-22 20:03:53 +02:00
Tom McFarlin
parent
626a161581
commit
791920143e
1 changed files with 288 additions and 270 deletions
|
|
@ -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:
|
||||||
*
|
*
|
||||||
|
|
@ -38,267 +54,269 @@ License:
|
||||||
* @version 1.0.0
|
* @version 1.0.0
|
||||||
*/
|
*/
|
||||||
class PluginName {
|
class PluginName {
|
||||||
|
|
||||||
/*--------------------------------------------*
|
/*--------------------------------------------*
|
||||||
* Properties
|
* Properties
|
||||||
*--------------------------------------------*/
|
*--------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Refers to a single instance of this class.
|
* Refers to a single instance of this class.
|
||||||
* @access private
|
*
|
||||||
* @var object
|
* @access private
|
||||||
*/
|
* @var object
|
||||||
private static $instance = null;
|
*/
|
||||||
|
private static $instance = null;
|
||||||
/**
|
|
||||||
* Refers to the slug of the plugin screen.
|
/**
|
||||||
* @access private
|
* Refers to the slug of the plugin screen.
|
||||||
* @var string
|
*
|
||||||
*/
|
* @access private
|
||||||
private $plugin_screen_slug = null;
|
* @var string
|
||||||
|
*/
|
||||||
/*--------------------------------------------*
|
private $plugin_screen_slug = null;
|
||||||
* Constructor
|
|
||||||
*--------------------------------------------*/
|
/*--------------------------------------------*
|
||||||
|
* Constructor
|
||||||
/**
|
*--------------------------------------------*/
|
||||||
* Creates or returns an instance of this class.
|
|
||||||
*
|
/**
|
||||||
* @since 1.0.0
|
* Creates or returns an instance of this class.
|
||||||
* @return PluginName A single instance of this class.
|
*
|
||||||
*/
|
* @since 1.0.0
|
||||||
public function get_instance() {
|
* @return PluginName A single instance of this class.
|
||||||
|
*/
|
||||||
// If the single instance hasn't been set, set it now.
|
public function get_instance() {
|
||||||
if( null == self::$instance ) {
|
|
||||||
self::$instance = new self;
|
// If the single instance hasn't been set, set it now.
|
||||||
} // end if
|
if ( null == self::$instance ) {
|
||||||
|
self::$instance = new self;
|
||||||
return self::$instance;
|
} // end if
|
||||||
|
|
||||||
} // end get_instance;
|
return self::$instance;
|
||||||
|
|
||||||
/**
|
} // end get_instance;
|
||||||
* Initializes the plugin by setting localization, filters, and administration functions.
|
|
||||||
*
|
/**
|
||||||
* @since 1.0.0
|
* Initializes the plugin by setting localization, filters, and administration functions.
|
||||||
*/
|
*
|
||||||
private function __construct() {
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
// Load plugin text domain
|
private function __construct() {
|
||||||
add_action( 'init', array( $this, 'load_plugin_textdomain' ) );
|
|
||||||
|
// 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 the options page and menu item.
|
||||||
//add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) );
|
* 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
|
* Register admin styles and scripts
|
||||||
* admin pages.
|
* 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
|
||||||
* add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_styles' ) );
|
* admin pages.
|
||||||
* add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_scripts' ) );
|
*
|
||||||
*/
|
* 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 site stylesheets and JavaScript
|
||||||
|
add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_styles' ) );
|
||||||
// Register hooks that are fired when the plugin is activated, deactivated, and uninstalled, respectively.
|
add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_scripts' ) );
|
||||||
register_activation_hook( __FILE__, array( $this, 'activate' ) );
|
|
||||||
register_deactivation_hook( __FILE__, array( $this, 'deactivate' ) );
|
// 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
|
* TODO:
|
||||||
* add_action/add_filter calls are the hooks into which your code should fire.
|
*
|
||||||
*
|
* Define the custom functionality for your plugin. The first parameter of the
|
||||||
* The second parameter is the function name located within this class. See the stubs
|
* add_action/add_filter calls are the hooks into which your code should fire.
|
||||||
* later in the file.
|
*
|
||||||
*
|
* The second parameter is the function name located within this class. See the stubs
|
||||||
* For more information:
|
* later in the file.
|
||||||
* http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters
|
*
|
||||||
*/
|
* For more information:
|
||||||
add_action( 'TODO', array( $this, 'action_method_name' ) );
|
* http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters
|
||||||
add_filter( 'TODO', array( $this, 'filter_method_name' ) );
|
*/
|
||||||
|
add_action( 'TODO', array( $this, 'action_method_name' ) );
|
||||||
} // end constructor
|
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
|
* Fired when the plugin is activated.
|
||||||
*/
|
*
|
||||||
public function activate( $network_wide ) {
|
* @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
|
||||||
// TODO: Define activation functionality here
|
*/
|
||||||
} // end activate
|
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
|
* Fired when the plugin is deactivated.
|
||||||
* @since 1.0.0
|
*
|
||||||
*/
|
* @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 ) {
|
* @since 1.0.0
|
||||||
// TODO: Define deactivation functionality here
|
*/
|
||||||
} // end deactivate
|
public function deactivate( $network_wide ) {
|
||||||
|
// TODO: Define deactivation functionality here
|
||||||
/**
|
} // end deactivate
|
||||||
* Loads the plugin text domain for translation
|
|
||||||
*/
|
/**
|
||||||
public function load_plugin_textdomain() {
|
* Loads the plugin text domain for translation
|
||||||
|
*/
|
||||||
// TODO: replace "plugin-name-locale" with a unique value for your plugin
|
public function load_plugin_textdomain() {
|
||||||
$domain = 'plugin-name-locale';
|
|
||||||
$locale = apply_filters( 'plugin_locale', get_locale(), $domain );
|
// 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_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/' );
|
||||||
|
|
||||||
} // end load_plugin_textdomain
|
} // end load_plugin_textdomain
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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__ ) );
|
wp_enqueue_style( 'plugin-name-admin-styles', plugins_url( 'css/admin.css', __FILE__ ), PLUGIN_NAME_VERSION );
|
||||||
} // end if
|
} // end if
|
||||||
|
|
||||||
} // end if
|
} // end if
|
||||||
|
|
||||||
} // end register_admin_styles
|
} // end register_admin_styles
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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' ) );
|
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
|
||||||
|
|
||||||
} // 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
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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', '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' )
|
||||||
);
|
);
|
||||||
|
|
||||||
} // end add_plugin_admin_menu
|
} // end add_plugin_admin_menu
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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');
|
||||||
} // end add_plugin_admin_page
|
} // end add_plugin_admin_page
|
||||||
|
|
||||||
/*--------------------------------------------*
|
/*--------------------------------------------*
|
||||||
* Core Functions
|
* Core Functions
|
||||||
*---------------------------------------------*/
|
*---------------------------------------------*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* 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
|
||||||
} // end action_method_name
|
} // end action_method_name
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* 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
|
||||||
} // end filter_method_name
|
} // end filter_method_name
|
||||||
|
|
||||||
} // end class
|
} // end class
|
||||||
|
|
||||||
// TODO: Update the instantiation call of your plugin to the name given at the class definition
|
// TODO: Update the instantiation call of your plugin to the name given at the class definition
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue