diff --git a/.gitignore b/.gitignore index 4a48538..3c5a4e2 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,39 @@ -.DS_store \ No newline at end of file +# Numerous always-ignore extensions +*.diff +*.err +*.orig +*.log +*.rej +*.swo +*.swp +*.vi +*~ +*.sass-cache + +# OS or Editor folders +.DS_Store +Thumbs.db +.cache +.project +.settings +.tmproj +*.esproj +nbproject +*.sublime-project +*.sublime-workspace + +# Dreamweaver added files +_notes +dwsync.xml + +# Komodo +*.komodoproject +.komodotools + +# Folders to ignore +.hg +.svn +.CVS +intermediate +.idea +cache diff --git a/README.txt b/README.txt index e69de29..63eba98 100644 --- a/README.txt +++ b/README.txt @@ -0,0 +1,110 @@ +=== Plugin Name === +Contributors: username1, username2 (this should be a list of wordpress.org userid's) +Donate link: http://example.com/ +Tags: comments, spam +Requires at least: 2.0.2 +Tested up to: 2.1 +Stable tag: 4.3 + +Here is a short description of the plugin. This should be no more than 150 characters. No markup here. + +== Description == + +This is the long description. No limit, and you can use Markdown (as well as in the following sections). + +For backwards compatibility, if this section is missing, the full length of the short description will be used, and +Markdown parsed. + +A few notes about the sections above: + +* "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames +* "Tags" is a comma separated list of tags that apply to the plugin +* "Requires at least" is the lowest version that the plugin will work on +* "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on +higher versions... this is just the highest one you've verified. +* Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for +stable. + + Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so +if the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used +for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt` +is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in +your in-development version, without having that information incorrectly disclosed about the current stable version +that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag. + + If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where +you put the stable version, in order to eliminate any doubt. + +== Installation == + +This section describes how to install the plugin and get it working. + +e.g. + +1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory +1. Activate the plugin through the 'Plugins' menu in WordPress +1. Place `` in your templates + +== Frequently Asked Questions == + += A question that someone might have = + +An answer to that question. + += What about foo bar? = + +Answer to foo bar dilemma. + +== Screenshots == + +1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from +the directory of the stable readme.txt, so in this case, `/tags/4.3/screenshot-1.png` (or jpg, jpeg, gif) +2. This is the second screen shot + +== Changelog == + += 1.0 = +* A change since the previous version. +* Another change. + += 0.5 = +* List versions from most recent at top to oldest at bottom. + +== Upgrade Notice == + += 1.0 = +Upgrade notices describe the reason a user should upgrade. No more than 300 characters. + += 0.5 = +This version fixes a security related bug. Upgrade immediately. + +== Arbitrary section == + +You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated +plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or +"installation." Arbitrary sections will be shown below the built-in sections outlined above. + +== A brief Markdown Example == + +Ordered list: + +1. Some feature +1. Another feature +1. Something else about the plugin + +Unordered list: + +* something +* something else +* third thing + +Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax]. +Titles are optional, naturally. + +[markdown syntax]: http://daringfireball.net/projects/markdown/syntax + "Markdown is what the parser uses to process much of the readme file" + +Markdown uses email style notation for blockquotes and I've been told: +> Asterisks for *emphasis*. Double it up for **strong**. + +`` diff --git a/plugin.php b/plugin.php index 7c236bd..483bb17 100644 --- a/plugin.php +++ b/plugin.php @@ -40,7 +40,7 @@ class TODO { // Define constants used throughout the plugin $this->init_plugin_constants(); - load_plugin_textdomain(PLUGIN_LOCALE, false, dirname(plugin_basename(__FILE__)) . '/lang'); + load_plugin_textdomain( PLUGIN_LOCALE, false, dirname( plugin_basename( __FILE__ ) ) . '/lang' ); /* * TODO: @@ -53,8 +53,8 @@ class TODO { * For more information: * 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')); + add_action( 'TODO', array( $this, 'action_method_name' ) ); + add_filter( 'TODO', array( $this, 'filter_method_name' ) ); } // end constructor @@ -95,8 +95,8 @@ class TODO { * * For example: wordpress-widget-boilerplate-locale. */ - if(!defined('PLUGIN_LOCALE')) { - define('PLUGIN_LOCALE', 'plugin-name-locale'); + if ( !defined( 'PLUGIN_LOCALE' ) ) { + define( 'PLUGIN_LOCALE', 'plugin-name-locale' ); } // end if /* TODO @@ -106,8 +106,8 @@ class TODO { * * For example: WordPress Widget Boilerplate. */ - if(!defined('PLUGIN_NAME')) { - define('PLUGIN_NAME', 'Plugin Name'); + if ( !defined( 'PLUGIN_NAME' ) ) { + define( 'PLUGIN_NAME', 'Plugin Name' ); } // end if /* TODO @@ -120,8 +120,8 @@ class TODO { * * For example: wordpress-widget-boilerplate */ - if(!defined('PLUGIN_SLUG')) { - define('PLUGIN_SLUG', 'plugin-name-slug'); + if ( !defined( 'PLUGIN_SLUG' ) ) { + define( 'PLUGIN_SLUG', 'plugin-name-slug' ); } // end if } // end init_plugin_constants @@ -133,16 +133,16 @@ class TODO { * @file_path The path to the actual file * @is_script Optional argument for if the incoming file_path is a JavaScript source file. */ - private function load_file($name, $file_path, $is_script = false) { + private function load_file( $name, $file_path, $is_script = false ) { $url = WP_PLUGIN_URL . $file_path; $file = WP_PLUGIN_DIR . $file_path; - if(file_exists($file)) { - if($is_script) { - wp_register_script($name, $url); - wp_enqueue_script($name); + if( file_exists( $file ) ) { + if( $is_script ) { + wp_register_script( $name, $url ); + wp_enqueue_script( $name ); } else { - wp_register_style($name, $url); - wp_enqueue_style($name); + wp_register_style( $name, $url ); + wp_enqueue_style( $name ); } // end if } // end if } // end _load_file