1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-11-16 18:49:29 +02:00
WordPress-Plugin-Boilerplate/plugin-name/trunk/admin/class-plugin-name-admin.php
Tom McFarlin 57205587af Making the file headers more conssitent
Improving the documentation for each file, as well.

Fix #193
2014-07-30 15:16:32 -04:00

103 lines
2.4 KiB
PHP

<?php
/**
* The dashboard-specific functionality of the plugin.
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/includes
*/
/**
* The dashboard-specific functionality of the plugin.
*
* Defines the plugin name, version, and two examples hooks for how to
* enqueue the dashboard-specific stylesheet and JavaScript.
*
* @package Plugin_Name
* @subpackage Plugin_Name/admin
* @author Your Name <email@example.com>
*/
class Plugin_Name_Admin {
/**
* The ID of this plugin.
*
* @since 1.0.0
* @access private
* @var string $name The ID of this plugin.
*/
private $name;
/**
* The version of this plugin.
*
* @since 1.0.0
* @access private
* @var string $version The current version of this plugin.
*/
private $version;
/**
* Initialize the class and set its properties.
*
* @since 1.0.0
* @var string $name The name of this plugin.
* @var string $version The version of this plugin.
*/
public function __construct( $name, $version ) {
$this->name = $name;
$this->version = $version;
}
/**
* Register the stylesheets for the Dashboard.
*
* @since 1.0.0
*/
public function enqueue_styles() {
/**
* This function is provided for demonstration purposes only.
*
* An instance of this class should be passed to the run() function
* defined in Plugin_Name_Admin_Loader as all of the hooks are defined
* in that particular class.
*
* The Plugin_Name_Admin_Loader will then create the relationship
* between the defined hooks and the functions defined in this
* class.
*/
wp_enqueue_style( $this->name, plugin_dir_url( __FILE__ ) . 'css/plugin-name-admin.css', array(), $this->version, 'all' );
}
/**
* Register the JavaScript for the dashboard.
*
* @since 1.0.0
*/
public function enqueue_scripts() {
/**
* This function is provided for demonstration purposes only.
*
* An instance of this class should be passed to the run() function
* defined in Plugin_Name_Admin_Loader as all of the hooks are defined
* in that particular class.
*
* The Plugin_Name_Admin_Loader will then create the relationship
* between the defined hooks and the functions defined in this
* class.
*/
wp_enqueue_script( $this->name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-admin.js', array( 'jquery' ), $this->version, FALSE );
}
}