1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-22 11:53:53 +02:00

Initial commit.

This commit is contained in:
tommcfarlin 2011-07-11 17:37:07 -04:00
commit 49ac1357eb
10 changed files with 182 additions and 0 deletions

0
README.txt Normal file
View file

1
css/admin.css Normal file
View file

@ -0,0 +1 @@
/* This stylesheet is used to style the admin option form of the widget. */

1
css/display.css Normal file
View file

@ -0,0 +1 @@
/* This stylesheet is used to style the public view of the plugin. */

3
js/admin.js Normal file
View file

@ -0,0 +1,3 @@
jQuery(function($) {
// Place your administration-specific code here
});

3
js/display.js Normal file
View file

@ -0,0 +1,3 @@
jQuery(function($) {
// Place your public facing JavaScript here
});

BIN
lang/plugin.mo Normal file

Binary file not shown.

17
lang/plugin.po Normal file
View file

@ -0,0 +1,17 @@
msgid ""
msgstr ""
"Project-Id-Version: WordPress Plugin Boilerplate\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2011-07-11 12:22-0500\n"
"PO-Revision-Date: 2011-07-11 12:22-0500\n"
"Last-Translator: \n"
"Language-Team: Tom McFarlin <tom@tommcfarlin.com>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"X-Poedit-KeywordsList: __;_e\n"
"X-Poedit-Basepath: .\n"
"X-Poedit-Language: English\n"
"X-Poedit-Country: UNITED STATES\n"
"X-Poedit-SourceCharset: utf-8\n"
"X-Poedit-SearchPath-0: ..\n"

155
plugin.php Normal file
View file

@ -0,0 +1,155 @@
<?php
/*
Plugin Name: TODO
Plugin URI: TODO
Description: TODO
Version: 1.0
Author: TODO
Author URI: TODO
License:
Copyright 2011 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 yuour plugin
class TODO {
/*--------------------------------------------*
* Constructor
*--------------------------------------------*/
/**
* Initializes the plugin by setting localization, filters, and administration functions.
*/
function __construct() {
// Define constnats used throughout the plugin
$this->init_plugin_constants();
load_plugin_textdomain(PLUGIN_LOCALE, false, dirname(plugin_basename(__FILE__)) . '/lang');
/*
* 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 if
} // end constructor
/*--------------------------------------------*
* Core Functions
*---------------------------------------------*/
/**
* Note: Actions are points in the execution of a page or process
* lifecycle that WordPress fires.
*/
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.
*/
function filter_method_name() {
// TODO define your filter method here
} // end filter_method_name
/*--------------------------------------------*
* Private Functions
*---------------------------------------------*/
/**
* Initializes constants used for convenience throughout
* the plugin.
*/
private function init_plugin_constants() {
/* TODO
*
* This provides the unique identifier for your plugin used in
* localizing the strings used throughout.
*
* For example: wordpress-widget-boilerplate-locale.
*/
if(!defined('PLUGIN_LOCALE')) {
define('PLUGIN_LOCALE', 'plugin-name-locale');
} // end if
/* TODO
*
* Define this as the name of your plugin. This is what shows
* in the Widgets area of WordPress.
*
* For example: WordPress Widget Boilerplate.
*/
if(!defined('PLUGIN_NAME')) {
define('PLUGIN_NAME', 'Plugin Name');
} // 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
*/
if(!defined('PLUGIN_SLUG')) {
define('PLUGIN_SLUG', 'plugin-name-slug');
} // end if
} // end init_plugin_constants
/**
* Helper function for registering and loading scripts and styles.
*
* @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.
*/
private function load_file($name, $file_path, $is_script = false) {
$url = WP_PLUGIN_URL . $file_path;
$file = WP_PLUGIN_DIR . $file_path;
if(file_exists($file)) {
if($is_script) {
wp_register_script($name, $url);
wp_enqueue_script($name);
} else {
wp_register_style($name, $url);
wp_enqueue_style($name);
} // end if
} // end if
} // end _load_file
} // end class
// TODO: update the instantiation call of your plugin to the name given at the class definition
new TODO();
?>

1
views/admin.php Normal file
View file

@ -0,0 +1 @@
<!-- This file is used to markup the administration form of the plugin.. -->

1
views/display.php Normal file
View file

@ -0,0 +1 @@
<!-- This file is used to markup the public facing aspect of the plugin. -->