New in WPCandy Labs: WordPress plugin and theme header creators

3 Comments

You might have noticed a new addition to the primary blog navigation above: Labs. WPCandy Labs is just a section of the site where I can tuck away fun little ideas and projects and test them out. Initially the WPCandy Labs page was empty, but I added it up in the navigation regardless as a reminder that I need to spend time on new ideas and fill that section of the site up.

I’m happy to point you to two new, simple additions to the Labs today. First is the WordPress Theme CSS Header Creator, and second is the WordPress Plugin Header Creator.

Those names just roll right off the tongue, don’t they?

So wait, what are they?

Basically the “Header Creators” are just forms that accept information about your theme or your plugin (particularly those you intend to submit to WordPress.org/extend) and gives you back a properly formatted comment section for the top of your plugin file or style.css file.

In case you weren’t aware, a properly formatted commented header in your theme’s style.css file is what helps WordPress understand what your theme is and display it in the dashboard. Plugin header files are similar, except that the comments sit at the top of the main PHP file within the plugin folder instead of in a stylesheet.

The CSS Header Creator, then, will output something like this:

/*
Theme Name: WPCandy Theme
Theme URI: http://wpcandy.com
Description: This is a WPCandy theme, for demo purposes of course.
Author: Ryan Imel
Author URI: http://wpcandy.com
Version: 1.0
Tags: blue, light, two-columns, right-sidebar, fixed-width, buddypress, custom-menu, editor-style, post-formats, threaded-comments

License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
*/

While the Plugin Header Creator will give you something like this:

php
/*
Plugin Name: WPCandy Functionality Plugin
Plugin URI: http://wpcandy.com
Description: This is a (demo) version of the functionality plugin used at WPCandy.com.
Version: 2.1
Author: Ryan Imel
Author URI: http://wpcandy.com
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
*/

Nothing world-changing, but hopefully a neat little tool that you can use to avoid copying and pasting from other plugins and themes in the future.

Both tools are available on the WPCandy Labs page.

3 thoughts on “New in WPCandy Labs: WordPress plugin and theme header creators

  1. You should include the following in both:

    Text Domain: example-plugin-or-theme-slug
    Domain Path: /languages/

    —> This, making plugin and theme authors MORE AWARE of internationalizing their plugins & themes (which is really needed, hehe!).

    Thanks, Dave 🙂

    • Absolutely agree, Dave. Note that support for Text Domain and Domain Path only comes to themes in 3.4, but there’s no harm in including them now.

      Also worth pointing out that Author URI and Theme/Plugin URI should not be the same (and are not allowed to be the same to pass the theme review process).

      The Template header, for child themes, might be a nice addition as well.

      Excited to see tools like this — anything to improve education and consistency is good in my book. Nice work.

      • It asks for the template folder name if you check the “this is a child theme” box under the theme’s name. I’ll look into the other ideas, thanks.

Comments are closed.