mirror of
https://github.com/inretio/WordPress-Plugin-Boilerplate
synced 2024-12-22 20:03:53 +02:00
adding proper page-level documentation
This commit is contained in:
Tom McFarlin
parent
0a069fa2e7
commit
f867e2b7f1
1 changed files with 128 additions and 144 deletions
|
|
@ -1,59 +1,65 @@
|
|||
<?php
|
||||
// If this file is called directly, abort.
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* The WordPress Plugin Boilerplate.
|
||||
*
|
||||
* A foundation off of which to build well-documented WordPress plugins that also follow
|
||||
* WordPress coding standards and PHP best practices.
|
||||
*
|
||||
* Use PHPDoc tags if you wish to be able to document the code using a documentation
|
||||
* generator.
|
||||
* Plugin Name.
|
||||
*
|
||||
* @package PluginName
|
||||
* @author Your Name <email@example.com>
|
||||
* @copyright 2013 Your Name or Company Name
|
||||
* @license GPL-2.0+
|
||||
* @link TODO
|
||||
* @version 1.0.0
|
||||
* @link http://example.com/plugin-name
|
||||
*/
|
||||
|
||||
/**
|
||||
* Plugin class.
|
||||
*
|
||||
* TODO: Rename this class to a proper name for your plugin.
|
||||
*
|
||||
* @package PluginName
|
||||
* @author Your Name <email@example.com>
|
||||
*/
|
||||
class PluginName {
|
||||
|
||||
/**
|
||||
* Refers to a single instance of this class.
|
||||
* Plugin version, used for cache-busting of style and script file references.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $version = '1.0.0';
|
||||
|
||||
/**
|
||||
* Unique identifier for your plugin.
|
||||
*
|
||||
* Use this value (not the variable name) as the text domain when internationalizing strings of text. It 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;
|
||||
|
||||
/**
|
||||
* Refers to the slug of the plugin screen.
|
||||
* Slug of the plugin screen.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $plugin_screen_slug = null;
|
||||
protected $plugin_screen_hook_suffix = null;
|
||||
|
||||
/**
|
||||
* Creates or returns an instance of this class.
|
||||
*
|
||||
* @since 1.0.0
|
||||
* @return PluginName A single instance of this class.
|
||||
*/
|
||||
public 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;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes the plugin by setting localization, filters, and administration functions.
|
||||
* Initialize the plugin by setting localization, filters, and administration functions.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
@ -62,47 +68,44 @@ class PluginName {
|
|||
// Load plugin text domain
|
||||
add_action( 'init', array( $this, 'load_plugin_textdomain' ) );
|
||||
|
||||
/*
|
||||
* Add the options page and menu item.
|
||||
* Uncomment the following line to enable the Settings Page for the plugin:
|
||||
*/
|
||||
//add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) );
|
||||
// Add the options page and menu item.
|
||||
// add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) );
|
||||
|
||||
/*
|
||||
* Register admin styles and scripts
|
||||
* If the Settings page has been activated using the above hook, the scripts and styles
|
||||
* will only be loaded on the settings page. If not, they will be loaded for all
|
||||
* admin pages.
|
||||
*
|
||||
* add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_styles' ) );
|
||||
* add_action( 'admin_enqueue_scripts', array( $this, 'register_admin_scripts' ) );
|
||||
*/
|
||||
// Enqueue admin styles and scripts.
|
||||
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) );
|
||||
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) );
|
||||
|
||||
// Register site stylesheets and JavaScript
|
||||
add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_styles' ) );
|
||||
add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_scripts' ) );
|
||||
// Enqueue public style and scripts.
|
||||
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_styles' ) );
|
||||
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
|
||||
|
||||
/*
|
||||
* 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
|
||||
*/
|
||||
// Define custom functionality. See 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;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fired when the plugin is activated.
|
||||
*
|
||||
* @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
|
||||
* @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 ) {
|
||||
// TODO: Define activation functionality here
|
||||
|
|
@ -111,108 +114,91 @@ class PluginName {
|
|||
/**
|
||||
* Fired when the plugin is deactivated.
|
||||
*
|
||||
* @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
|
||||
* @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 ) {
|
||||
// TODO: Define deactivation functionality here
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the plugin text domain for translation
|
||||
* Load the plugin text domain for translation.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public function load_plugin_textdomain() {
|
||||
|
||||
// TODO: replace "plugin-name-locale" with a unique value for your plugin
|
||||
$domain = 'plugin-name-locale';
|
||||
$domain = $this->plugin_slug;
|
||||
$locale = apply_filters( 'plugin_locale', get_locale(), $domain );
|
||||
|
||||
load_textdomain( $domain, WP_LANG_DIR . '/' . $domain . '/' . $domain . '-' . $locale . '.mo' );
|
||||
load_plugin_textdomain( $domain, FALSE, dirname( plugin_basename( __FILE__ ) ) . '/lang/' );
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers and enqueues admin-specific styles.
|
||||
* Enqueue admin-specific style sheets.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @return null Return early if no settings page is registered.
|
||||
*/
|
||||
public function register_admin_styles() {
|
||||
public function enqueue_admin_styles() {
|
||||
|
||||
/*
|
||||
* Check if the plugin has registered a settings page
|
||||
* and if it has, make sure only to enqueue the scripts on the relevant screens
|
||||
*/
|
||||
|
||||
if ( isset( $this->plugin_screen_slug ) ) {
|
||||
|
||||
/*
|
||||
* Check if current screen is the admin page for this plugin
|
||||
* Don't enqueue stylesheet or JavaScript if it's not
|
||||
*/
|
||||
if ( ! isset( $this->plugin_screen_hook_suffix ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$screen = get_current_screen();
|
||||
if ( $screen->id == $this->plugin_screen_slug ) {
|
||||
wp_enqueue_style( 'plugin-name-admin-styles', plugins_url( 'css/admin.css', __FILE__ ), PLUGIN_NAME_VERSION );
|
||||
}
|
||||
|
||||
if ( $screen->id == $this->plugin_screen_hook_suffix ) {
|
||||
wp_enqueue_style( $this->plugin_slug .'-admin-styles', plugins_url( 'css/admin.css', __FILE__ ), $this->version );
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers and enqueues admin-specific JavaScript.
|
||||
* Enqueue admin-specific JavaScript.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @return null Return early if no settings page is registered.
|
||||
*/
|
||||
public function register_admin_scripts() {
|
||||
public function enqueue_admin_scripts() {
|
||||
|
||||
/*
|
||||
* Check if the plugin has registered a settings page
|
||||
* and if it has, make sure only to enqueue the scripts on the relevant screens
|
||||
*/
|
||||
|
||||
if ( isset( $this->plugin_screen_slug ) ) {
|
||||
|
||||
/*
|
||||
* Check if current screen is the admin page for this plugin
|
||||
* Don't enqueue stylesheet or JavaScript if it's not
|
||||
*/
|
||||
if ( ! isset( $this->plugin_screen_hook_suffix ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$screen = get_current_screen();
|
||||
if ( $screen->id == $this->plugin_screen_slug ) {
|
||||
wp_enqueue_script( 'plugin-name-admin-script', plugins_url('js/admin.js', __FILE__), array( 'jquery' ), PLUGIN_NAME_VERSION );
|
||||
}
|
||||
|
||||
if ( $screen->id == $this->plugin_screen_hook_suffix ) {
|
||||
wp_enqueue_script( $this->plugin_slug . '-admin-script', plugins_url( 'js/admin.js', __FILE__ ), array( 'jquery' ), $this->version );
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers and enqueues public-facing stylesheets.
|
||||
* Enqueue public-facing style sheets.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public function register_plugin_styles() {
|
||||
wp_enqueue_style( 'plugin-name-plugin-styles', plugins_url( 'css/display.css', __FILE__ ), PLUGIN_NAME_VERSION );
|
||||
public function enqueue_styles() {
|
||||
wp_enqueue_style( $this->plugin_slug . '-plugin-styles', plugins_url( 'css/public.css', __FILE__ ), $this->version );
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers and enqueues public-facing JavaScript.
|
||||
* Enqueues public-facing script files.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public function register_plugin_scripts() {
|
||||
wp_enqueue_script( 'plugin-name-plugin-script', plugins_url( 'js/display.js', __FILE__ ), array( 'jquery' ), PLUGIN_NAME_VERSION );
|
||||
public function enqueue_scripts() {
|
||||
wp_enqueue_script( $this->plugin_slug . '-plugin-script', plugins_url( 'js/public.js', __FILE__ ), array( 'jquery' ), $this->version );
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers the administration menu for this plugin into the WordPress Dashboard menu.
|
||||
* Register the administration menu for this plugin into the WordPress Dashboard menu.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public function add_plugin_admin_menu() {
|
||||
|
||||
/*
|
||||
* TODO:
|
||||
*
|
||||
|
|
@ -220,26 +206,25 @@ class PluginName {
|
|||
* Change 'Menu Text' to the text for menu item for the plugin settings page
|
||||
* Change 'plugin-name' to the name of your plugin
|
||||
*/
|
||||
$this->plugin_screen_slug = add_plugins_page(
|
||||
__('Page Title', 'plugin-name-locale'),
|
||||
__('Menu Text', 'plugin-name-locale'),
|
||||
$this->plugin_screen_hook_suffix = add_plugins_page(
|
||||
__('Page Title', 'plugin-name'),
|
||||
__('Menu Text', 'plugin-name'),
|
||||
'read',
|
||||
'plugin-name',
|
||||
$this->plugin_slug,
|
||||
array( $this, 'display_plugin_admin_page' )
|
||||
);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Renders the options page for this plugin.
|
||||
* Render the settings page for this plugin.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public function display_plugin_admin_page() {
|
||||
include_once('views/admin.php');
|
||||
include_once( 'views/admin.php' );
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* NOTE: Actions are points in the execution of a page or process
|
||||
* lifecycle that WordPress fires.
|
||||
*
|
||||
|
|
@ -249,10 +234,10 @@ class PluginName {
|
|||
* @since 1.0.0
|
||||
*/
|
||||
public function action_method_name() {
|
||||
// TODO: Define your action method here
|
||||
// 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.
|
||||
*
|
||||
|
|
@ -262,7 +247,6 @@ class PluginName {
|
|||
* @since 1.0.0
|
||||
*/
|
||||
public function filter_method_name() {
|
||||
// TODO: Define your filter method here
|
||||
// TODO: Define your filter hook callback here
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in a new issue