mirror of
https://github.com/inretio/WordPress-Plugin-Boilerplate
synced 2025-04-27 09:35:35 +03:00
* Moving the boilerplate to its own directory
* Adding an improved README * Removing unused features of the boilerplate * Officially tagging as 1.0
This commit is contained in:
Tom McFarlin
parent
47edae47e6
commit
e4bbd52ae0
10 changed files with 75 additions and 22 deletions
178
plugin.php
178
plugin.php
|
|
@ -1,178 +0,0 @@
|
|||
<?php
|
||||
/*
|
||||
Plugin Name: TODO
|
||||
Plugin URI: TODO
|
||||
Description: TODO
|
||||
Version: 1.0
|
||||
Author: TODO
|
||||
Author URI: TODO
|
||||
Author Email: TODO
|
||||
License:
|
||||
|
||||
Copyright 2012 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 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
|
||||
|
||||
*/
|
||||
|
||||
// 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, '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_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
|
||||
* 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.
|
||||
*
|
||||
* @params $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.
|
||||
*
|
||||
* @params $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
|
||||
} // end deactivate
|
||||
|
||||
/**
|
||||
* Fired when the plugin is uninstalled.
|
||||
*
|
||||
* @params $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
|
||||
} // end uninstall
|
||||
|
||||
/**
|
||||
* Loads the plugin text domain for translation
|
||||
*/
|
||||
public function textdomain() {
|
||||
// TODO: replace "plugin-name-locale" with a unique value for your plugin
|
||||
load_plugin_textdomain( 'plugin-name-locale', false, dirname( plugin_basename( __FILE__ ) ) . '/lang' );
|
||||
}
|
||||
|
||||
/**
|
||||
* 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' ) );
|
||||
|
||||
} // 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' ) );
|
||||
|
||||
} // end register_plugin_scripts
|
||||
|
||||
/*--------------------------------------------*
|
||||
* 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
|
||||
*
|
||||
*/
|
||||
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
|
||||
*
|
||||
*/
|
||||
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
|
||||
$plugin_name = new PluginName();
|
||||
Loading…
Add table
Add a link
Reference in a new issue