Skip to content
This repository has been archived by the owner on Apr 21, 2020. It is now read-only.

OOP, extended API, example plugin #6

Merged
merged 4 commits into from Jun 28, 2012
Merged

OOP, extended API, example plugin #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f985bae
moved to OOP, improved API, added example plugin
Jun 28, 2012
4d80ff6
removed some left over debug code
Jun 28, 2012
0e9ce95
improved js styling
Jun 28, 2012
44aa630
remove active link for already active plugins
Jun 28, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 41 additions & 0 deletions example_plugin/register_addt_plugins_dir.php
View file
Open in desktop
@@ -0,0 +1,41 @@
<?php
! defined( 'ABSPATH' ) AND exit();
/*
Plugin Name: Additional Plugin Directories: Example Plugin
Plugin URI: http://github.com/chrisguitarguy
Description: Example Plugin to show how to register additional plugin directories
Version: 0.1
Author: Franz Josef Kaiser
Author URI: http://unserkaiser.com
License: MIT
*/


/**
* Registers a new plugin directory
*
* @example
* $args Array (Valid args for `root`) 'content', 'plugins', 'muplugins', 'root'
* The new directories must be subdirectories of the following WP file system constants:
* 'content': (default) WP_CONTENT_DIR
* 'plugins': WP_PLUGIN_DIR
* 'muplugins': WPMU_PLUGIN_DIR
* 'root': one level below WP_CONTENT_DIR
*
* @return void
*/
function cd_apd_register_additional_plugin_directories()
{
// Better abort - if we don't do this, we'll create an error on deactivation of the main plugin.
if ( ! function_exists( 'register_plugin_directory' ) )
return;

// Call the public API function once for every directory you want to add.
register_plugin_directory( array(
'dir' => 'example_plugin_directory'
,'label' => 'Example Label for the list table'
,'root' => 'plugins'
) );
}
// Needs to be added on the `plugins_loaded` hook with a priority of `0`.
add_action( 'plugins_loaded', 'cd_apd_register_additional_plugin_directories', 0 );
183 changes: 138 additions & 45 deletions inc/admin.php
View file
Open in desktop
@@ -1,57 +1,116 @@
<?php
! defined( 'ABSPATH' ) && exit();
! defined( 'ABSPATH' ) AND exit();


class CD_APD_Admin

if ( ! class_exists( 'CD_APD_Admin' ) )
{
add_action( 'plugins_loaded', array( 'CD_APD_Admin', 'instance' ) );
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hooking the main class into plugins_loaded on priority 10. This will allow people better control via hooks. It also makes sure, the new static $instance only runs once.


/**
* Admin/Factory
*
* @author Christopher Davis, Franz Josef Kaiser
* @license GPL
* @copyright © Christopher Davis, Franz Josef Kaiser 2011-2012
*
* @package WordPress
* @subpackage Additional Plugin Directories: Admin/Factory
*/
class CD_APD_Admin extends CD_APD_Core
{
/**
* Instance
*
* @since 0.3
* @access protected
* @var object
*/
protected static $instance;


/**
* The container for all of our custom plugins
*
* @since 0.1
* @access protected
* @var array
*/
protected $plugins = array();


/**
* What custom actions are we allowed to handle here?
*
* @since 0.1
* @access protected
* @var array
*/
protected $actions = array();


/**
* The original count of the plugins
*
* @since 0.1
* @access protected
* @var int
*/
protected $all_count = 0;


/**
* Creates a new static instance
*
* @since 0.3
* @static
* @return void
*/
public static function instance()
{
null === self :: $instance AND self :: $instance = new self;
return self :: $instance;
}


/**
* constructor
*
* @since 0.1
* @since 0.1
* @return void
*/
public function __construct()
{
add_action( 'load-plugins.php', array( $this, 'init' ) );
add_action( 'plugins_loaded', array( $this, 'setup_actions' ), 1 );
add_action( 'load-plugins.php', array( $this, 'init' ) );
}


/**
* Sets up which actions we can handle with this plugin. We'll use this
* to catch activations and deactivations as the normal way won't work
* to catch activations and deactivations as the normal way won't work.
* Has the filter 'custom_plugin_actions' to allow extensions.
*
* @since 0.1
* @since 0.1
* @return void
*/
public function setup_actions()
{
$tmp = array(
'custom_activate',
'custom_deactivate'
$this->actions = apply_filters(
'custom_plugin_actions',
array(
'custom_activate',
'custom_deactivate'
)
);
$this->actions = apply_filters( 'custom_plugin_actions', $tmp );
}


/**
* Makes the magic happen. Loads all the other hooks to modify the
* plugin list table
* Makes the magic happen. Loads all the other hooks to modify the plugin list table
*
* @since 0.1
* @since 0.1
* @return void
*/
public function init()
{
Expand Down Expand Up @@ -81,7 +140,9 @@ public function init()
/**
* Adds our custom plugin directories to the list of plugin types
*
* @since 0.1
* @since 0.1
* @param array $views
* @return array $views
*/
public function views( $views )
{
Expand All @@ -94,15 +155,17 @@ public function views( $views )
// Add our directories to the action links
foreach ( $wp_plugin_directories as $key => $info )
{
if ( ! count( $this->plugins[$key] ) )
$count = count( $this->plugins[ $key ] );

if ( ! $count )
continue;

$views[ $key ] = sprintf(
'<a href="%s"%s>%s <span class="count">(%d)</span></a>',
add_query_arg( 'plugin_status', $key, 'plugins.php' ),
$this->get_plugin_status() == $key ? ' class="current" ' : '',
esc_html( $info['label'] ),
count( $this->plugins[ $key ] )
$count
);
}

Expand All @@ -112,6 +175,10 @@ public function views( $views )

/**
* Unset inactive plugin link as it doesn't really work for this view
*
* @since 0.1
* @param array $views
* @return array $views
*/
public function views_again( $views )
{
Expand All @@ -124,10 +191,15 @@ public function views_again( $views )

/**
* Filters the plugins list to include all the plugins in our custom directory
*
* @since 0.1
* @param array $plugins
* @return array $plugins
*/
public function filter_plugins( $plugins )
{
if ( $key = $this->get_plugin_status() )
$key = $this->get_plugin_status();
if ( $key )
{
$this->all_count = count( $plugins );
$plugins = $this->plugins[ $key] ;
Expand All @@ -139,23 +211,32 @@ public function filter_plugins( $plugins )

/**
* Correct some action links so we can actually "activate" plugins
*
* @since 0.1
* @param array $links
* @param string $plugin_file
* @return array $links
*/
public function action_links( $links, $plugin_file )
{
$context = $this->get_plugin_status();

$active = get_option( "active_plugins_{$context}", array() );

// let's just start over
$links = array();
$links['activate'] = sprintf(
'<a href="%s" title="Activate this plugin">%s</a>',
wp_nonce_url(
"plugins.php?action=custom_activate&amp;plugin={$plugin_file}&amp;plugin_status=".esc_attr( $context ),
"custom_activate-{$plugin_file}"
),
__( 'Activate' )
);
if ( ! in_array( $plugin_file, $active ) )
{
$links['activate'] = sprintf(
'<a href="%s" title="Activate this plugin">%s</a>',
wp_nonce_url(
"plugins.php?action=custom_activate&amp;plugin={$plugin_file}&amp;plugin_status=".esc_attr( $context ),
"custom_activate-{$plugin_file}"
),
__( 'Activate' )
);
}

$active = get_option( "active_plugins_{$context}", array() );
if ( in_array( $plugin_file, $active ) )
{
$links['deactivate'] = sprintf(
Expand All @@ -175,14 +256,18 @@ public function action_links( $links, $plugin_file )
/**
* Enqueues on JS file for fun hacks
*
* @since 0.1
* @uses wp_enqueue_script
* @since 0.1
* @uses wp_enqueue_script()
* @return void
*/
public function scripts()
public function scripts( $screen )
{
if ( 'plugins.php' !== $screen )
return;

wp_enqueue_script(
'cd-apd-js',
CD_APD_URL . 'js/apd.js',
CD_APD_URL.'js/apd.js',
array( 'jquery' ),
null
);
Expand All @@ -199,8 +284,9 @@ public function scripts()
/**
* Fetch all the custom plugins we have!
*
* @since 0.1
* @uses cd_adp_get_plugins To fetch all the custom plugins
* @since 0.1
* @uses get_plugins_from_cache() To fetch all the custom plugins
* @return void
*/
public function get_plugins()
{
Expand All @@ -210,7 +296,7 @@ public function get_plugins()

foreach ( array_keys( $wp_plugin_directories ) as $key )
{
$this->plugins[ $key ] = cd_apd_get_plugins( $key );
$this->plugins[ $key ] = $this->get_plugins_from_cache( $key );
}
}

Expand All @@ -219,7 +305,8 @@ public function get_plugins()
* Handle activations and deactivations as the standard way will
* fail with "plugin file does not exist
*
* @since 0.1
* @since 0.1
* @return void
*/
public function handle_actions()
{
Expand All @@ -240,11 +327,11 @@ public function handle_actions()
{
case 'custom_activate':
if ( ! current_user_can('activate_plugins') )
wp_die( __('You do not have sufficient permissions to manage plugins for this site.') );
wp_die( __( 'You do not have sufficient permissions to manage plugins for this site.' ) );

check_admin_referer( "custom_activate-{$plugin}" );

$result = cd_apd_activate_plugin( $plugin, $context );
$result = $this->activate_plugin( $plugin, $context );
if ( is_wp_error( $result ) )
{
if ( 'unexpected_output' == $result->get_error_code() )
Expand Down Expand Up @@ -278,15 +365,21 @@ public function handle_actions()
wp_die( __( 'You do not have sufficient permissions to deactivate plugins for this site.' ) );

check_admin_referer( "custom_deactivate-{$plugin}" );
cd_apd_deactivate_plugins( $plugin, $context );

$this->deactivate_plugins( $plugin, $context );

if ( headers_sent() )
{
printf(
"<meta http-equiv='refresh' content='%s' />",
esc_attr( "0;url=plugins.php?deactivate=true&plugin_status={$status}&paged={$page}&s={$s}" )
);
}
else
wp_redirect( self_admin_url("plugins.php?deactivate=true&plugin_status={$context}") );
exit();
{
wp_redirect( self_admin_url( "plugins.php?deactivate=true&plugin_status={$context}" ) );
exit();
}
break;

default:
Expand All @@ -297,11 +390,11 @@ public function handle_actions()


/**
* Utility function to get the current `plugin_status` key returns
* false if our key isn't in the the custom directories
* Utility function to get the current `plugin_status`.
* The key returns FALSE if our key isn't in the the custom directories
*
* @since 0.1
* @return bool|string False on failure, the `$wp_plugin_directories` key on success
* @since 0.1
* @return bool|string $rv False on failure, the `$wp_plugin_directories` key on success
*/
public function get_plugin_status()
{
Expand All @@ -319,6 +412,6 @@ public function get_plugin_status()

return $rv;
}
} // end class
} // END Class CD_APD_Admin

new CD_APD_Admin();
} // endif;