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
|
2011-12-03 06:28:54 +02:00
|
|
|
Author Email: TODO
|
2011-07-12 00:37:07 +03:00
|
|
|
License:
|
|
|
|
|
2012-03-06 05:33:04 +02:00
|
|
|
Copyright 2012 TODO (email@domain.com)
|
2011-07-12 00:37:07 +03:00
|
|
|
|
2011-12-03 06:28:54 +02: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
|
|
|
|
2011-12-03 06:28:54 +02: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
|
|
|
|
2011-12-03 06:28:54 +02: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 yuour plugin
|
2011-12-03 06:28:54 +02:00
|
|
|
class PluginName {
|
|
|
|
|
2011-12-05 14:56:43 +02:00
|
|
|
/*--------------------------------------------*
|
|
|
|
* Constants
|
|
|
|
*--------------------------------------------*/
|
|
|
|
|
2011-12-03 06:28:54 +02:00
|
|
|
/**
|
2011-12-05 14:56:43 +02:00
|
|
|
* TODO: update these values to reflect the name and slug of your plugin.
|
2011-12-03 06:28:54 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
const name = 'Plugin Name';
|
|
|
|
|
|
|
|
const slug = 'plugin-name-slug';
|
2011-07-12 00:37:07 +03:00
|
|
|
|
|
|
|
/*--------------------------------------------*
|
|
|
|
* Constructor
|
|
|
|
*--------------------------------------------*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Initializes the plugin by setting localization, filters, and administration functions.
|
|
|
|
*/
|
|
|
|
function __construct() {
|
|
|
|
|
2011-10-07 05:55:47 +03:00
|
|
|
// Define constants used throughout the plugin
|
|
|
|
$this->init_plugin_constants();
|
2011-07-12 00:37:07 +03:00
|
|
|
|
2011-10-19 22:40:39 +03:00
|
|
|
load_plugin_textdomain( PLUGIN_LOCALE, false, dirname( plugin_basename( __FILE__ ) ) . '/lang' );
|
2011-07-12 00:37:07 +03:00
|
|
|
|
2011-12-03 06:28:54 +02:00
|
|
|
// Load JavaScript and stylesheets
|
|
|
|
$this->register_scripts_and_styles();
|
|
|
|
|
2011-10-07 05:55:47 +03:00
|
|
|
/*
|
|
|
|
* 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
|
|
|
|
|
|
|
|
/*--------------------------------------------*
|
|
|
|
* Core Functions
|
|
|
|
*---------------------------------------------*/
|
|
|
|
|
2011-10-07 05:55:47 +03:00
|
|
|
/**
|
|
|
|
* Note: Actions are points in the execution of a page or process
|
|
|
|
* lifecycle that WordPress fires.
|
2011-12-03 06:28:54 +02:00
|
|
|
*
|
|
|
|
* WordPress Actions: http://codex.wordpress.org/Plugin_API#Actions
|
|
|
|
* Action Reference: http://codex.wordpress.org/Plugin_API/Action_Reference
|
|
|
|
*
|
2011-10-07 05:55:47 +03:00
|
|
|
*/
|
2011-07-12 00:37:07 +03:00
|
|
|
function action_method_name() {
|
2011-10-07 05:55:47 +03:00
|
|
|
// TODO define your action method here
|
2011-07-12 00:37:07 +03:00
|
|
|
} // end action_method_name
|
|
|
|
|
2011-10-07 05:55:47 +03:00
|
|
|
/**
|
|
|
|
* Note: Filters are points of execution in which WordPress modifies data
|
|
|
|
* before saving it or sending it to the browser.
|
2011-12-03 06:28:54 +02:00
|
|
|
*
|
|
|
|
* WordPress Filters: http://codex.wordpress.org/Plugin_API#Filters
|
|
|
|
* Filter Reference: http://codex.wordpress.org/Plugin_API/Filter_Reference
|
|
|
|
*
|
2011-10-07 05:55:47 +03:00
|
|
|
*/
|
|
|
|
function filter_method_name() {
|
|
|
|
// TODO define your filter method here
|
2011-07-12 00:37:07 +03:00
|
|
|
} // end filter_method_name
|
|
|
|
|
|
|
|
/*--------------------------------------------*
|
|
|
|
* Private Functions
|
|
|
|
*---------------------------------------------*/
|
|
|
|
|
2011-10-07 05:55:47 +03:00
|
|
|
/**
|
|
|
|
* Initializes constants used for convenience throughout
|
|
|
|
* the plugin.
|
|
|
|
*/
|
|
|
|
private function init_plugin_constants() {
|
|
|
|
|
|
|
|
/* TODO
|
|
|
|
*
|
|
|
|
* Define this as the name of your plugin. This is what shows
|
|
|
|
* in the Widgets area of WordPress.
|
|
|
|
*
|
|
|
|
* For example: WordPress Widget Boilerplate.
|
|
|
|
*/
|
2011-10-19 22:40:39 +03:00
|
|
|
if ( !defined( 'PLUGIN_NAME' ) ) {
|
2011-12-05 14:56:43 +02:00
|
|
|
define( 'PLUGIN_NAME', self::name );
|
2011-10-07 05:55:47 +03:00
|
|
|
} // end if
|
|
|
|
|
|
|
|
/* TODO
|
|
|
|
*
|
|
|
|
* this is the slug of your plugin used in initializing it with
|
|
|
|
* the WordPress API.
|
|
|
|
|
|
|
|
* This should also be the
|
|
|
|
* directory in which your plugin resides. Use hyphens.
|
|
|
|
*
|
|
|
|
* For example: wordpress-widget-boilerplate
|
|
|
|
*/
|
2011-10-19 22:40:39 +03:00
|
|
|
if ( !defined( 'PLUGIN_SLUG' ) ) {
|
2011-12-05 14:56:43 +02:00
|
|
|
define( 'PLUGIN_SLUG', self::slug );
|
2011-10-07 05:55:47 +03:00
|
|
|
} // end if
|
|
|
|
|
|
|
|
} // end init_plugin_constants
|
2011-07-12 00:37:07 +03:00
|
|
|
|
2011-12-03 06:28:54 +02:00
|
|
|
/**
|
|
|
|
* Registers and enqueues stylesheets for the administration panel and the
|
|
|
|
* public facing site.
|
|
|
|
*/
|
|
|
|
private function register_scripts_and_styles() {
|
|
|
|
if ( is_admin() ) {
|
2012-01-19 15:25:40 +02:00
|
|
|
$this->load_file( self::slug . '-admin-script', '/js/admin.js', true );
|
|
|
|
$this->load_file( self::slug . '-admin-style', '/css/admin.css' );
|
2011-12-03 06:28:54 +02:00
|
|
|
} else {
|
2012-01-19 15:25:40 +02:00
|
|
|
$this->load_file( self::slug . '-script', '/js/widget.js', true );
|
|
|
|
$this->load_file( self::slug . '-style', '/css/widget.css' );
|
2011-12-03 06:28:54 +02:00
|
|
|
} // end if/else
|
|
|
|
} // end register_scripts_and_styles
|
|
|
|
|
2011-07-12 00:37:07 +03:00
|
|
|
/**
|
2012-01-19 15:25:40 +02:00
|
|
|
* Helper function for registering and enqueueing scripts and styles.
|
2011-07-12 00:37:07 +03:00
|
|
|
*
|
|
|
|
* @name The ID to register with WordPress
|
|
|
|
* @file_path The path to the actual file
|
|
|
|
* @is_script Optional argument for if the incoming file_path is a JavaScript source file.
|
|
|
|
*/
|
2011-10-19 22:40:39 +03:00
|
|
|
private function load_file( $name, $file_path, $is_script = false ) {
|
2011-12-03 06:28:54 +02:00
|
|
|
|
2012-01-19 15:25:40 +02:00
|
|
|
$url = plugins_url($file_path, __FILE__);
|
2012-01-20 00:42:10 +02:00
|
|
|
$file = plugin_dir_path(__FILE__) . $file_path;
|
2012-01-19 15:25:40 +02:00
|
|
|
|
2011-10-19 22:40:39 +03:00
|
|
|
if( file_exists( $file ) ) {
|
|
|
|
if( $is_script ) {
|
2012-01-19 15:25:40 +02:00
|
|
|
wp_register_script( $name, $url, array('jquery') );
|
2011-10-19 22:40:39 +03:00
|
|
|
wp_enqueue_script( $name );
|
2011-07-12 00:37:07 +03:00
|
|
|
} else {
|
2011-10-19 22:40:39 +03:00
|
|
|
wp_register_style( $name, $url );
|
|
|
|
wp_enqueue_style( $name );
|
2011-07-12 00:37:07 +03:00
|
|
|
} // end if
|
|
|
|
} // end if
|
2012-01-19 15:25:40 +02:00
|
|
|
|
|
|
|
} // end load_file
|
2011-07-12 00:37:07 +03:00
|
|
|
|
|
|
|
} // end class
|
|
|
|
// TODO: update the instantiation call of your plugin to the name given at the class definition
|
2011-12-03 06:28:54 +02:00
|
|
|
new PluginName();
|
2011-07-12 00:37:07 +03:00
|
|
|
?>
|