myplugin/view/admin * myplugin/view/myplugin* * Admin templates are contained within 'admin', and user templates are contained within a directory of the same name as the plugin. * * User files can be overridden within the theme by creating a similar directory structure: * *
/themes/mytheme/view/myplugin* * The class will first look in the theme and then defaults to the plugin. A plugin should always provide default templates. * *
<p>You processed <?php echo $items ?> items</p>* * When you want to display this in your plugin you use: * *
$this->render_admin ('processed', array ('items' => 100));
*
* @package WordPress base library
* @author John Godley
* @copyright Copyright (C) John Godley
**/
class Advanced_Permalinks_Plugin
{
/**
* Plugin name
* @var string
**/
var $plugin_name;
/**
* Plugin 'view' directory
* @var string Directory
**/
var $plugin_base;
/**
* Register your plugin with a name and base directory. This must be called once.
*
* @param string $name Name of your plugin. Is used to determine the plugin locale domain
* @param string $base Directory containing the plugin's 'view' files.
* @return void
**/
function register_plugin ($name, $base)
{
$this->plugin_base = rtrim (dirname ($base), '/');
$this->plugin_name = $name;
$this->add_action ('init', 'load_locale');
}
function load_locale ()
{
// Here we manually fudge the plugin locale as WP doesnt allow many options
$locale = get_locale ();
if ( empty($locale) )
$locale = 'en_US';
$mofile = dirname (__FILE__)."/locale/$locale.mo";
load_textdomain ($this->plugin_name, $mofile);
}
/**
* Register a WordPress action and map it back to the calling object
*
* @param string $action Name of the action
* @param string $function Function name (optional)
* @param int $priority WordPress priority (optional)
* @param int $accepted_args Number of arguments the function accepts (optional)
* @return void
**/
function add_action ($action, $function = '', $priority = 10, $accepted_args = 1)
{
add_action ($action, array (&$this, $function == '' ? $action : $function), $priority, $accepted_args);
}
/**
* Register a WordPress filter and map it back to the calling object
*
* @param string $action Name of the action
* @param string $function Function name (optional)
* @param int $priority WordPress priority (optional)
* @param int $accepted_args Number of arguments the function accepts (optional)
* @return void
**/
function add_filter ($filter, $function = '', $priority = 10, $accepted_args = 1)
{
add_filter ($filter, array (&$this, $function == '' ? $filter : $function), $priority, $accepted_args);
}
/**
* Special activation function that takes into account the plugin directory
*
* @param string $pluginfile The plugin file location (i.e. __FILE__)
* @param string $function Optional function name, or default to 'activate'
* @return void
**/
function register_activation ($pluginfile, $function = '')
{
add_action ('activate_'.basename (dirname ($pluginfile)).'/'.basename ($pluginfile), array (&$this, $function == '' ? 'activate' : $function));
}
/**
* Special deactivation function that takes into account the plugin directory
*
* @param string $pluginfile The plugin file location (i.e. __FILE__)
* @param string $function Optional function name, or default to 'deactivate'
* @return void
**/
function register_deactivation ($pluginfile, $function = '')
{
add_action ('deactivate_'.basename (dirname ($pluginfile)).'/'.basename ($pluginfile), array (&$this, $function == '' ? 'deactivate' : $function));
}
/**
* Renders an admin section of display code
*
* @param string $ug_name Name of the admin file (without extension)
* @param string $array Array of variable name=>value that is available to the display code (optional)
* @return void
**/
function render_admin ($ug_name, $ug_vars = array ())
{
global $plugin_base;
foreach ($ug_vars AS $key => $val)
$$key = $val;
if (file_exists ("{$this->plugin_base}/view/admin/$ug_name.php"))
include ("{$this->plugin_base}/view/admin/$ug_name.php");
else
echo "Rendering of admin template {$this->plugin_base}/view/admin/$ug_name.php failed
";
}
/**
* Renders a section of user display code. The code is first checked for in the current theme display directory
* before defaulting to the plugin
*
* @param string $ug_name Name of the admin file (without extension)
* @param string $array Array of variable name=>value that is available to the display code (optional)
* @return void
**/
function render ($ug_name, $ug_vars = array ())
{
foreach ($ug_vars AS $key => $val)
$$key = $val;
if (file_exists (TEMPLATEPATH."/view/{$this->plugin_name}/$ug_name.php"))
include (TEMPLATEPATH."/view/{$this->plugin_name}/$ug_name.php");
else if (file_exists ("{$this->plugin_base}/view/{$this->plugin_name}/$ug_name.php"))
include ("{$this->plugin_base}/view/{$this->plugin_name}/$ug_name.php");
else
echo "Rendering of template $ug_name.php failed
";
}
/**
* Renders a section of user display code. The code is first checked for in the current theme display directory
* before defaulting to the plugin
*
* @param string $ug_name Name of the admin file (without extension)
* @param string $array Array of variable name=>value that is available to the display code (optional)
* @return void
**/
function capture ($ug_name, $ug_vars = array ())
{
ob_start ();
$this->render ($ug_name, $ug_vars);
$output = ob_get_contents ();
ob_end_clean ();
return $output;
}
/**
* Captures an admin section of display code
*
* @param string $ug_name Name of the admin file (without extension)
* @param string $array Array of variable name=>value that is available to the display code (optional)
* @return string Captured code
**/
function capture_admin ($ug_name, $ug_vars = array ())
{
ob_start ();
$this->render_admin ($ug_name, $ug_vars);
$output = ob_get_contents ();
ob_end_clean ();
return $output;
}
/**
* Display a standard error message (using CSS ID 'message' and classes 'fade' and 'error)
*
* @param string $message Message to display
* @return void
**/
function render_error ($message)
{
?>