1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-23 04:13:53 +02:00
WordPress-Plugin-Boilerplate/plugin-boilerplate/plugin.php

252 lines
7.9 KiB
PHP
Raw Normal View History

2011-07-12 00:37:07 +03:00
<?php
/*
Plugin Name: TODO
Plugin URI: TODO
Description: TODO
Version: 1.0
Author: TODO
Author URI: TODO
Author Email: TODO
2011-07-12 00:37:07 +03:00
License:
2013-01-17 04:43:54 +02:00
Copyright 2013 TODO (email@domain.com)
2011-07-12 00:37:07 +03:00
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.
2011-07-12 00:37:07 +03:00
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.
2011-07-12 00:37:07 +03:00
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
2011-07-12 00:37:07 +03:00
*/
// TODO: rename this class to a proper name for your plugin
class PluginName {
2013-05-08 00:00:38 +03:00
/*--------------------------------------------*
* Attributes
*--------------------------------------------*/
/** Refers to a single instance of this class. */
private static $instance;
2011-07-12 00:37:07 +03:00
/*--------------------------------------------*
* Constructor
*--------------------------------------------*/
2013-05-08 00:00:38 +03:00
/**
* Creates or returns an instance of this class.
*
* @return PluginName A single instance of this class.
*/
public function get_instance() {
return null == self::$instance ? new self : self::$instance;
} // end get_instance;
2011-07-12 00:37:07 +03:00
/**
* Initializes the plugin by setting localization, filters, and administration functions.
*/
2013-05-08 00:00:38 +03:00
private function __construct() {
// Load plugin text domain
add_action( 'init', array( $this, 'plugin_textdomain' ) );
2012-11-06 05:07:10 +02:00
// Add the options page and menu item
// Uncomment the following line to enable the Settings Page for the plugin
2013-05-08 00:00:38 +03:00
# add_action('admin_menu', array( $this, 'plugin_admin_menu' ) );
// Register admin styles and scripts
// If the Settings page has been activated (above), 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 styles and scripts
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
*/
2011-10-19 22:40:39 +03:00
add_action( 'TODO', array( $this, 'action_method_name' ) );
add_filter( 'TODO', array( $this, 'filter_method_name' ) );
2011-07-12 00:37:07 +03:00
} // 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
*/
public function deactivate( $network_wide ) {
// TODO: Define deactivation functionality here
} // end deactivate
2012-11-06 05:07:10 +02:00
/**
* Loads the plugin text domain for translation
*/
public function plugin_textdomain() {
2012-11-06 05:07:10 +02:00
// TODO: replace "plugin-name-locale" with a unique value for your plugin
2013-01-30 22:11:12 +02:00
$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 plugin_textdomain
2012-11-06 05:07:10 +02:00
/**
* Registers and enqueues admin-specific styles.
*/
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 script/style if it's not
*/
$screen = get_current_screen();
if ( $screen->id != $this->plugin_screen_slug )
return;
}
wp_enqueue_style( 'plugin-name-admin-styles', plugins_url( 'css/admin.css', __FILE__ ) );
} // end register_admin_styles
/**
* Registers and enqueues admin-specific JavaScript.
*/
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 script/style if it's not
*/
$screen = get_current_screen();
if ( $screen->id != $this->plugin_screen_slug )
return;
}
wp_enqueue_script( 'plugin-name-admin-script', plugins_url( 'js/admin.js', __FILE__ ), array('jquery') );
} // end register_admin_scripts
/**
* Registers and enqueues plugin-specific styles.
*/
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.
*/
public function register_plugin_scripts() {
wp_enqueue_script( 'plugin-name-plugin-script', plugins_url( 'js/display.js', __FILE__ ), array('jquery') );
} // end register_plugin_scripts
2013-05-08 00:01:12 +03:00
public function plugin_admin_menu() {
// TODO: Change 'Page Title' to the title of your plugin admin page
// TODO: Change 'Menu Text' to the text for menu item for the plugin settings page
// TODO: Change 'plugin-name' to the name of your plugin
$this->plugin_screen_slug = add_plugins_page('Page Title', 'Menu Text', 'read', 'plugin-name', array( $this, 'plugin_admin_page' ));
} // end plugin_admin_menu
2013-05-08 00:01:12 +03:00
public function plugin_admin_page() {
// output the cpanel
include_once('views/admin_open.php');
include_once('views/admin.php'); // outputs the settings/form markup for the plugin admin markup
include_once('views/admin_close.php');
} // end plugin_admin_page
2011-07-12 00:37:07 +03:00
/*--------------------------------------------*
* 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
*
*/
2013-05-08 00:01:12 +03:00
public function action_method_name() {
// TODO: Define your action method here
2011-07-12 00:37:07 +03:00
} // 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
*
*/
2013-05-08 00:01:12 +03:00
public function filter_method_name() {
// TODO: Define your filter method here
2011-07-12 00:37:07 +03:00
} // end filter_method_name
2011-07-12 00:37:07 +03:00
} // end class
2012-07-14 05:14:34 +03:00
// TODO: Update the instantiation call of your plugin to the name given at the class definition
2013-05-08 00:00:38 +03:00
PluginName::get_instance();