From 32884b051576c207eea86643f58d3f7672e72a16 Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 30 Oct 2013 16:49:30 -0400 Subject: [PATCH] removing files from the main plugin directory in favor of admin and public specific directories related #100 --- plugin-name/class-plugin-name-admin.php | 232 ------------------ plugin-name/class-plugin-name.php | 308 ------------------------ plugin-name/css/admin.css | 1 - plugin-name/css/index.php | 1 - plugin-name/css/public.css | 1 - plugin-name/js/admin.js | 10 - plugin-name/js/index.php | 1 - plugin-name/js/public.js | 10 - 8 files changed, 564 deletions(-) delete mode 100644 plugin-name/class-plugin-name-admin.php delete mode 100644 plugin-name/class-plugin-name.php delete mode 100644 plugin-name/css/admin.css delete mode 100644 plugin-name/css/index.php delete mode 100644 plugin-name/css/public.css delete mode 100644 plugin-name/js/admin.js delete mode 100644 plugin-name/js/index.php delete mode 100644 plugin-name/js/public.js diff --git a/plugin-name/class-plugin-name-admin.php b/plugin-name/class-plugin-name-admin.php deleted file mode 100644 index 9498d1d..0000000 --- a/plugin-name/class-plugin-name-admin.php +++ /dev/null @@ -1,232 +0,0 @@ - - * @license GPL-2.0+ - * @link http://example.com - * @copyright 2013 Your Name or Company Name - */ - -/** - * Plugin class. This class should ideally be used to work with the - * administrative side of the WordPress site. - * - * If you're interested in introducing public-facing - * functionality, then refer to `class-plugin-name.php` - * - * TODO: Rename this class to a proper name for your plugin. - * - * @package Plugin_Name_Admin - * @author Your Name - */ -class Plugin_Name_Admin { - - /** - * Instance of this class. - * - * @since 1.0.0 - * - * @var object - */ - protected static $instance = null; - - /** - * Slug of the plugin screen. - * - * @since 1.0.0 - * - * @var string - */ - protected $plugin_screen_hook_suffix = null; - - /** - * Initialize the plugin by loading admin scripts & styles and adding a - * settings page and menu. - * - * @since 1.0.0 - */ - private function __construct() { - - /* - * Call $plugin_slug from public plugin class. - * - * TODO: - * - * - Rename "Plugin_Name" to the name of your initial plugin class - * - */ - $plugin = Plugin_Name::get_instance(); - $this->plugin_slug = $plugin->get_plugin_slug(); - - // Load admin style sheet and JavaScript. - add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) ); - add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) ); - - // Add the options page and menu item. - add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) ); - - // Add an action link pointing to the options page. - $plugin_basename = plugin_basename( plugin_dir_path( __FILE__ ) . $this->plugin_slug . '.php' ); - add_filter( 'plugin_action_links_' . $plugin_basename, array( $this, 'add_action_links' ) ); - - /* - * Define custom functionality. - * - * Read more about actions and filters: - * 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' ) ); - - } - - /** - * Return an instance of this class. - * - * @since 1.0.0 - * - * @return object A single instance of this class. - */ - public static function get_instance() { - - // If the single instance hasn't been set, set it now. - if ( null == self::$instance ) { - self::$instance = new self; - } - - return self::$instance; - } - - /** - * Register and enqueue admin-specific style sheet. - * - * TODO: - * - * - Rename "Plugin_Name" to the name your plugin - * - * @since 1.0.0 - * - * @return null Return early if no settings page is registered. - */ - public function enqueue_admin_styles() { - - if ( ! isset( $this->plugin_screen_hook_suffix ) ) { - return; - } - - $screen = get_current_screen(); - if ( $this->plugin_screen_hook_suffix == $screen->id ) { - wp_enqueue_style( $this->plugin_slug .'-admin-styles', plugins_url( 'css/admin.css', __FILE__ ), array(), Plugin_Name::VERSION ); - } - - } - - /** - * Register and enqueue admin-specific JavaScript. - * - * TODO: - * - * - Rename "Plugin_Name" to the name your plugin - * - * @since 1.0.0 - * - * @return null Return early if no settings page is registered. - */ - public function enqueue_admin_scripts() { - - if ( ! isset( $this->plugin_screen_hook_suffix ) ) { - return; - } - - $screen = get_current_screen(); - if ( $this->plugin_screen_hook_suffix == $screen->id ) { - wp_enqueue_script( $this->plugin_slug . '-admin-script', plugins_url( 'js/admin.js', __FILE__ ), array( 'jquery' ), Plugin_Name::VERSION ); - } - - } - - /** - * Register the administration menu for this plugin into the WordPress Dashboard menu. - * - * @since 1.0.0 - */ - public function add_plugin_admin_menu() { - - /* - * Add a settings page for this plugin to the Settings menu. - * - * NOTE: Alternative menu locations are available via WordPress administration menu functions. - * - * Administration Menus: http://codex.wordpress.org/Administration_Menus - * - * TODO: - * - * - Change 'Page Title' to the title of your plugin admin page - * - Change 'Menu Text' to the text for menu item for the plugin settings page - * - Change 'manage_options' to the capability you see fit - * For reference: http://codex.wordpress.org/Roles_and_Capabilities - */ - $this->plugin_screen_hook_suffix = add_options_page( - __( 'Page Title', $this->plugin_slug ), - __( 'Menu Text', $this->plugin_slug ), - 'manage_options', - $this->plugin_slug, - array( $this, 'display_plugin_admin_page' ) - ); - - } - - /** - * Render the settings page for this plugin. - * - * @since 1.0.0 - */ - public function display_plugin_admin_page() { - include_once( 'views/admin.php' ); - } - - /** - * Add settings action link to the plugins page. - * - * @since 1.0.0 - */ - public function add_action_links( $links ) { - - return array_merge( - array( - 'settings' => '' . __( 'Settings', $this->plugin_slug ) . '' - ), - $links - ); - - } - - /** - * NOTE: Actions are points in the execution of a page or process - * lifecycle that WordPress fires. - * - * Actions: http://codex.wordpress.org/Plugin_API#Actions - * Reference: http://codex.wordpress.org/Plugin_API/Action_Reference - * - * @since 1.0.0 - */ - public function action_method_name() { - // TODO: Define your action hook callback here - } - - /** - * NOTE: Filters are points of execution in which WordPress modifies data - * before saving it or sending it to the browser. - * - * Filters: http://codex.wordpress.org/Plugin_API#Filters - * Reference: http://codex.wordpress.org/Plugin_API/Filter_Reference - * - * @since 1.0.0 - */ - public function filter_method_name() { - // TODO: Define your filter hook callback here - } - -} diff --git a/plugin-name/class-plugin-name.php b/plugin-name/class-plugin-name.php deleted file mode 100644 index 4579ce1..0000000 --- a/plugin-name/class-plugin-name.php +++ /dev/null @@ -1,308 +0,0 @@ - - * @license GPL-2.0+ - * @link http://example.com - * @copyright 2013 Your Name or Company Name - */ - -/** - * Plugin class. This class should ideally be used to work with the - * public-facing side of the WordPress site. - * - * If you're interested in introducing administrative or dashboard - * functionality, then refer to `class-plugin-name-admin.php` - * - * TODO: Rename this class to a proper name for your plugin. - * - * @package Plugin_Name - * @author Your Name - */ -class Plugin_Name { - - /** - * Plugin version, used for cache-busting of style and script file references. - * - * @since 1.0.0 - * - * @var string - */ - const VERSION = '1.0.0'; - - /** - * TODO - Rename "plugin-name" to the name your your plugin - * - * Unique identifier for your plugin. - * - * - * The variable name is used as the text domain when internationalizing strings - * of text. Its value should match the Text Domain file header in the main - * plugin file. - * - * @since 1.0.0 - * - * @var string - */ - protected $plugin_slug = 'plugin-name'; - - /** - * Instance of this class. - * - * @since 1.0.0 - * - * @var object - */ - protected static $instance = null; - - /** - * Initialize the plugin by setting localization and loading public scripts - * and styles. - * - * @since 1.0.0 - */ - private function __construct() { - - // Load plugin text domain - add_action( 'init', array( $this, 'load_plugin_textdomain' ) ); - - // Activate plugin when new blog is added - add_action( 'wpmu_new_blog', array( $this, 'activate_new_site' ) ); - - // Load public-facing style sheet and JavaScript. - add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_styles' ) ); - add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) ); - - /* Define custom functionality. - * Refer To 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' ) ); - - } - - /** - * Return the plugin slug. - * - * @since 1.0.0 - * - *@return Plugin slug variable. - */ - public function get_plugin_slug() { - return $this->plugin_slug; - } - - /** - * Return an instance of this class. - * - * @since 1.0.0 - * - * @return object A single instance of this class. - */ - public static function get_instance() { - - // If the single instance hasn't been set, set it now. - if ( null == self::$instance ) { - self::$instance = new self; - } - - return self::$instance; - } - - /** - * Fired when the plugin is activated. - * - * @since 1.0.0 - * - * @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 static function activate( $network_wide ) { - - if ( function_exists( 'is_multisite' ) && is_multisite() ) { - - if ( $network_wide ) { - - // Get all blog ids - $blog_ids = self::get_blog_ids(); - - foreach ( $blog_ids as $blog_id ) { - - switch_to_blog( $blog_id ); - self::single_activate(); - } - - restore_current_blog(); - - } else { - self::single_activate(); - } - - } else { - self::single_activate(); - } - - } - - /** - * Fired when the plugin is deactivated. - * - * @since 1.0.0 - * - * @param boolean $network_wide True if WPMU superadmin uses - * "Network Deactivate" action, false if - * WPMU is disabled or plugin is - * deactivated on an individual blog. - */ - public static function deactivate( $network_wide ) { - - if ( function_exists( 'is_multisite' ) && is_multisite() ) { - - if ( $network_wide ) { - - // Get all blog ids - $blog_ids = self::get_blog_ids(); - - foreach ( $blog_ids as $blog_id ) { - - switch_to_blog( $blog_id ); - self::single_deactivate(); - - } - - restore_current_blog(); - - } else { - self::single_deactivate(); - } - - } else { - self::single_deactivate(); - } - - } - - /** - * Fired when a new site is activated with a WPMU environment. - * - * @since 1.0.0 - * - * @param int $blog_id ID of the new blog. - */ - public function activate_new_site( $blog_id ) { - - if ( 1 !== did_action( 'wpmu_new_blog' ) ) { - return; - } - - switch_to_blog( $blog_id ); - self::single_activate(); - restore_current_blog(); - - } - - /** - * Get all blog ids of blogs in the current network that are: - * - not archived - * - not spam - * - not deleted - * - * @since 1.0.0 - * - * @return array|false The blog ids, false if no matches. - */ - private static function get_blog_ids() { - - global $wpdb; - - // get an array of blog ids - $sql = "SELECT blog_id FROM $wpdb->blogs - WHERE archived = '0' AND spam = '0' - AND deleted = '0'"; - - return $wpdb->get_col( $sql ); - - } - - /** - * Fired for each blog when the plugin is activated. - * - * @since 1.0.0 - */ - private static function single_activate() { - // TODO: Define activation functionality here - } - - /** - * Fired for each blog when the plugin is deactivated. - * - * @since 1.0.0 - */ - private static function single_deactivate() { - // TODO: Define deactivation functionality here - } - - /** - * Load the plugin text domain for translation. - * - * @since 1.0.0 - */ - public function load_plugin_textdomain() { - - $domain = $this->plugin_slug; - $locale = apply_filters( 'plugin_locale', get_locale(), $domain ); - - load_textdomain( $domain, trailingslashit( WP_LANG_DIR ) . $domain . '/' . $domain . '-' . $locale . '.mo' ); - load_plugin_textdomain( $domain, FALSE, basename( dirname( __FILE__ ) ) . '/languages/' ); - - } - - /** - * Register and enqueue public-facing style sheet. - * - * @since 1.0.0 - */ - public function enqueue_styles() { - wp_enqueue_style( $this->plugin_slug . '-plugin-styles', plugins_url( 'css/public.css', __FILE__ ), array(), self::VERSION ); - } - - /** - * Register and enqueues public-facing JavaScript files. - * - * @since 1.0.0 - */ - public function enqueue_scripts() { - wp_enqueue_script( $this->plugin_slug . '-plugin-script', plugins_url( 'js/public.js', __FILE__ ), array( 'jquery' ), self::VERSION ); - } - - /** - * NOTE: Actions are points in the execution of a page or process - * lifecycle that WordPress fires. - * - * Actions: http://codex.wordpress.org/Plugin_API#Actions - * Reference: http://codex.wordpress.org/Plugin_API/Action_Reference - * - * @since 1.0.0 - */ - public function action_method_name() { - // TODO: Define your action hook callback here - } - - /** - * NOTE: Filters are points of execution in which WordPress modifies data - * before saving it or sending it to the browser. - * - * Filters: http://codex.wordpress.org/Plugin_API#Filters - * Reference: http://codex.wordpress.org/Plugin_API/Filter_Reference - * - * @since 1.0.0 - */ - public function filter_method_name() { - // TODO: Define your filter hook callback here - } - -} \ No newline at end of file diff --git a/plugin-name/css/admin.css b/plugin-name/css/admin.css deleted file mode 100644 index a5854ad..0000000 --- a/plugin-name/css/admin.css +++ /dev/null @@ -1 +0,0 @@ -/* This stylesheet is used to style the admin option form of the plugin. */ \ No newline at end of file diff --git a/plugin-name/css/index.php b/plugin-name/css/index.php deleted file mode 100644 index e71af0e..0000000 --- a/plugin-name/css/index.php +++ /dev/null @@ -1 +0,0 @@ -