inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-22 11:53:53 +02:00
Code Issues Releases Wiki Activity

changing all 'TODO' to '@TODO'

Browse source 
changing all 'TODO' to '@TODO' so that they are easier to find in IDE's that support @TODO tags

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
This commit is contained in:
Tom McFarlin 2013-11-16 12:30:18 -05:00
parent adeb21c1c7
commit 119c874120
6 changed files with 35 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plugin-name/README.txt
View file

@ -1,4 +1,4 @@
=== TODO: Plugin Name === === @TODO: Plugin Name ===
Contributors: (this should be a list of wordpress.org userids) Contributors: (this should be a list of wordpress.org userids)
Donate link: http://example.com/ Donate link: http://example.com/
Tags: comments, spam Tags: comments, spam

30
plugin-name/admin/class-plugin-name-admin.php
View file

@ -16,7 +16,7 @@
* If you're interested in introducing public-facing * If you're interested in introducing public-facing
* functionality, then refer to `class-plugin-name.php` * functionality, then refer to `class-plugin-name.php`
* *
* TODO: Rename this class to a proper name for your plugin. * @TODO: Rename this class to a proper name for your plugin.
* *
* @package Plugin_Name_Admin * @package Plugin_Name_Admin
* @author Your Name <email@example.com> * @author Your Name <email@example.com>
@ -48,10 +48,10 @@ class Plugin_Name_Admin {
* @since 1.0.0 * @since 1.0.0
*/ */
private function __construct() { private function __construct() {
/* /*
* TODO : * @TODO :
* *
* - Decomment following lines if the admin class should only be available for super admins * - Decomment following lines if the admin class should only be available for super admins
*/ */
/* if( ! is_super_admin() ) { /* if( ! is_super_admin() ) {
@ -61,7 +61,7 @@ class Plugin_Name_Admin {
/* /*
* Call $plugin_slug from public plugin class. * Call $plugin_slug from public plugin class.
* *
* TODO: * @TODO:
* *
* - Rename "Plugin_Name" to the name of your initial plugin class * - Rename "Plugin_Name" to the name of your initial plugin class
* *
@ -86,8 +86,8 @@ class Plugin_Name_Admin {
* Read more about actions and filters: * Read more about actions and filters:
* http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters * http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters
*/ */
add_action( 'TODO', array( $this, 'action_method_name' ) ); add_action( '@TODO', array( $this, 'action_method_name' ) );
add_filter( 'TODO', array( $this, 'filter_method_name' ) ); add_filter( '@TODO', array( $this, 'filter_method_name' ) );
} }
@ -99,10 +99,10 @@ class Plugin_Name_Admin {
* @return object A single instance of this class. * @return object A single instance of this class.
*/ */
public static function get_instance() { public static function get_instance() {
/* /*
* TODO : * @TODO :
* *
* - Decomment following lines if the admin class should only be available for super admins * - Decomment following lines if the admin class should only be available for super admins
*/ */
/* if( ! is_super_admin() ) { /* if( ! is_super_admin() ) {
@ -120,7 +120,7 @@ class Plugin_Name_Admin {
/** /**
* Register and enqueue admin-specific style sheet. * Register and enqueue admin-specific style sheet.
* *
* TODO: * @TODO:
* *
* - Rename "Plugin_Name" to the name your plugin * - Rename "Plugin_Name" to the name your plugin
* *
@ -144,7 +144,7 @@ class Plugin_Name_Admin {
/** /**
* Register and enqueue admin-specific JavaScript. * Register and enqueue admin-specific JavaScript.
* *
* TODO: * @TODO:
* *
* - Rename "Plugin_Name" to the name your plugin * - Rename "Plugin_Name" to the name your plugin
* *
@ -179,7 +179,7 @@ class Plugin_Name_Admin {
* *
* Administration Menus: http://codex.wordpress.org/Administration_Menus * Administration Menus: http://codex.wordpress.org/Administration_Menus
* *
* TODO: * @TODO:
* *
* - Change 'Page Title' to the title of your plugin admin page * - 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 'Menu Text' to the text for menu item for the plugin settings page
@ -231,7 +231,7 @@ class Plugin_Name_Admin {
* @since 1.0.0 * @since 1.0.0
*/ */
public function action_method_name() { public function action_method_name() {
// TODO: Define your action hook callback here // @TODO: Define your action hook callback here
} }
/** /**
@ -244,7 +244,7 @@ class Plugin_Name_Admin {
* @since 1.0.0 * @since 1.0.0
*/ */
public function filter_method_name() { public function filter_method_name() {
// TODO: Define your filter hook callback here // @TODO: Define your filter hook callback here
} }
} }

2
plugin-name/admin/views/admin.php
View file

@ -18,6 +18,6 @@
<?php screen_icon(); ?> <?php screen_icon(); ?>
<h2><?php echo esc_html( get_admin_page_title() ); ?></h2> <h2><?php echo esc_html( get_admin_page_title() ); ?></h2>
<!-- TODO: Provide markup for your options page here. --> <!-- @TODO: Provide markup for your options page here. -->
</div> </div>

18
plugin-name/plugin-name.php
View file

@ -12,12 +12,12 @@
* @copyright 2013 Your Name or Company Name * @copyright 2013 Your Name or Company Name
* *
* @wordpress-plugin * @wordpress-plugin
* Plugin Name: TODO * Plugin Name: @TODO
* Plugin URI: TODO * Plugin URI: @TODO
* Description: TODO * Description: @TODO
* Version: 1.0.0 * Version: 1.0.0
* Author: TODO * Author: @TODO
* Author URI: TODO * Author URI: @TODO
* Text Domain: plugin-name-locale * Text Domain: plugin-name-locale
* License: GPL-2.0+ * License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt * License URI: http://www.gnu.org/licenses/gpl-2.0.txt
@ -35,7 +35,7 @@ if ( ! defined( 'WPINC' ) ) {
*----------------------------------------------------------------------------*/ *----------------------------------------------------------------------------*/
/* /*
* TODO: * @TODO:
* *
* - replace `class-plugin-name.php` with the name of the plugin's class file * - replace `class-plugin-name.php` with the name of the plugin's class file
* *
@ -46,7 +46,7 @@ require_once( plugin_dir_path( __FILE__ ) . 'public/class-plugin-name.php' );
* Register hooks that are fired when the plugin is activated or deactivated. * Register hooks that are fired when the plugin is activated or deactivated.
* When the plugin is deleted, the uninstall.php file is loaded. * When the plugin is deleted, the uninstall.php file is loaded.
* *
* TODO: * @TODO:
* *
* - replace Plugin_Name with the name of the class defined in * - replace Plugin_Name with the name of the class defined in
* `class-plugin-name.php` * `class-plugin-name.php`
@ -55,7 +55,7 @@ register_activation_hook( __FILE__, array( 'Plugin_Name', 'activate' ) );
register_deactivation_hook( __FILE__, array( 'Plugin_Name', 'deactivate' ) ); register_deactivation_hook( __FILE__, array( 'Plugin_Name', 'deactivate' ) );
/* /*
* TODO: * @TODO:
* *
* - replace Plugin_Name with the name of the class defined in * - replace Plugin_Name with the name of the class defined in
* `class-plugin-name.php` * `class-plugin-name.php`
@ -67,7 +67,7 @@ add_action( 'plugins_loaded', array( 'Plugin_Name', 'get_instance' ) );
*----------------------------------------------------------------------------*/ *----------------------------------------------------------------------------*/
/* /*
* TODO: * @TODO:
* *
* - replace `class-plugin-admin.php` with the name of the plugin's admin file * - replace `class-plugin-admin.php` with the name of the plugin's admin file
* - replace Plugin_Name_Admin with the name of the class defined in * - replace Plugin_Name_Admin with the name of the class defined in

16
plugin-name/public/class-plugin-name.php
View file

@ -16,7 +16,7 @@
* If you're interested in introducing administrative or dashboard * If you're interested in introducing administrative or dashboard
* functionality, then refer to `class-plugin-name-admin.php` * functionality, then refer to `class-plugin-name-admin.php`
* *
* TODO: Rename this class to a proper name for your plugin. * @TODO: Rename this class to a proper name for your plugin.
* *
* @package Plugin_Name * @package Plugin_Name
* @author Your Name <email@example.com> * @author Your Name <email@example.com>
@ -33,7 +33,7 @@ class Plugin_Name {
const VERSION = '1.0.0'; const VERSION = '1.0.0';
/** /**
* TODO - Rename "plugin-name" to the name your your plugin * @TODO - Rename "plugin-name" to the name your your plugin
* *
* Unique identifier for your plugin. * Unique identifier for your plugin.
* *
@ -78,8 +78,8 @@ class Plugin_Name {
/* Define custom functionality. /* Define custom functionality.
* Refer To http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters * Refer To http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters
*/ */
add_action( 'TODO', array( $this, 'action_method_name' ) ); add_action( '@TODO', array( $this, 'action_method_name' ) );
add_filter( 'TODO', array( $this, 'filter_method_name' ) ); add_filter( '@TODO', array( $this, 'filter_method_name' ) );
} }
@ -234,7 +234,7 @@ class Plugin_Name {
* @since 1.0.0 * @since 1.0.0
*/ */
private static function single_activate() { private static function single_activate() {
// TODO: Define activation functionality here // @TODO: Define activation functionality here
} }
/** /**
@ -243,7 +243,7 @@ class Plugin_Name {
* @since 1.0.0 * @since 1.0.0
*/ */
private static function single_deactivate() { private static function single_deactivate() {
// TODO: Define deactivation functionality here // @TODO: Define deactivation functionality here
} }
/** /**
@ -289,7 +289,7 @@ class Plugin_Name {
* @since 1.0.0 * @since 1.0.0
*/ */
public function action_method_name() { public function action_method_name() {
// TODO: Define your action hook callback here // @TODO: Define your action hook callback here
} }
/** /**
@ -302,7 +302,7 @@ class Plugin_Name {
* @since 1.0.0 * @since 1.0.0
*/ */
public function filter_method_name() { public function filter_method_name() {
// TODO: Define your filter hook callback here // @TODO: Define your filter hook callback here
} }
} }

2
plugin-name/uninstall.php
View file

@ -14,4 +14,4 @@ if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
exit; exit;
} }
// TODO: Define uninstall functionality here // @TODO: Define uninstall functionality here