I’m sure a lot of people reading that first thought “But wait! I put a lot of time into my plugin — I want people to know that it’s a plugin!” So we end up with an admin screen titled John’s Comment Filter Plugin 3.2 or worse, a “mystery meat” menu item that doesn’t identify what the plugin does at all¹! That first example is somewhat like having a store with a giant flashing neon sign up front — it certainly gets the information across, but it’s not all that attractive, and very obtrusive on the surrounding landscape.

I admit that we’re riding a line here — we all want credit for our hard work; but awkward plugin integration, spread out over multiple plugins, can end up making WordPress itself look awfully kludgy. Our blogs, and our plugins, deserve better than that!

So, we’re looking for a way to give credit where credit is due, while maintaining a clean integrated interface that looks as though it were a part of WordPress from the beginning. First, name the menu item for what the screen is for, not what the plugin is called. Ditto the page <title> and header. By way of example, my pull-quotes plugin is called “JavaScript Pull-Quotes”, but the Admin screen is under Design -> Pull-Quotes, and the page title and header read “Pull-Quote Settings”. The menu item and page header do not have to match the name of the plugin!

Okay, so… what if you still want to show the plugin name, and maybe have a link back to the plugin’s homepage? Simply allow your eyes to drift downward to the bottom of the admin screen…

There’s the name of the plugin, the version number, and a link back to the home page; but it’s discreet and unobtrusive — it looks as though it belongs there. The information is there if you’re interested, but it doesn’t get in your way if you’re not; giving us a good balance between giving credit and keeping the GUI clean. Of course, if enough plugin authors start doing it on all their plugins, people will come to expect that bit of extra info, and that little slice of screen real estate will be as good as gold.

Here’s how I do it:

• Within the function that creates the content of the Admin page itself, put the following line (probably best at the very beginning or very end of the function):

  add_action( 'in_admin_footer', 'myplugin_admin_footer' );
  

  This attaches a function to the page footer that will insert our attribution text.

• Then of course we have to add the footer function itself:

  function myplugin_admin_footer() {
  	$plugin_data = get_plugin_data( __FILE__ );
  	printf('%1$s plugin | Version %2$s<br />', $plugin_data['Title'], $plugin_data['Version']);
  }
  

That’s pretty straightforward — all we’re doing is outputting a line of HTML — but I should point out a couple of things. First, we’re wrapping it in an if() and checking against $_SERVER['REQUEST_URI'] because we don’t want our plugin’s attribution showing up on every page. (Of course, you’ll have to change the URL string in that if() so it’s right for your particular page.) You can use in_admin_footer to insert anything you like, of course, but in the interests of creating something resembling a standard, I hope you consider sticking to the format I give above. (One alternate that comes to mind, however, is that some people might prefer to use something like “Comments Filter Plugin | Version 3.2 | By John Smith”. Go for it. ) I definitely recommend the <br /> at the end of the text you’re inserting — otherwise it will be clumped on the same line as the existing text, which will look cluttered and will diminish your own plugin’s attribution.

We’ve just torn down the ugly neon sign, and replaced it with an engraved brass plaque next to the door. Not too bad, that. In the longer run, this is something that might be nice to roll into core WordPress code, which would really make it a consistent standard. Until then, it’s quite easy to give your own plugins credit in a way that cleanly and elegantly integrates with WordPress.

[Update: Ozh improved upon my code a bit by moving the add_action() into the function that creates the Admin page itself. It simplified things quite nicely, and the code above has been adjusted accordingly.]

[There are updates to this topic here and here.]

Previously: Use Action Links to direct users straight to your WordPress plugin’s admin page

Coming next: Consolidating your plugin’s settings so you don’t clutter up users’ wp_options tables

This article was originally published at Nerdaphernalia. Planet WordPress is authorized to reproduce WordPress-related entries. If you're reading this at any other web site, the site owner is stealing copyrighted work. Please visit the original page:

Feed enhanced by Better Feed from Ozh

My take on this is quite simple: From the user perspective, plugins should be invisible. That is, the fact that such-and-such part of the interface was made by a plugin should be invisible. The best design for a plugin is to seamlessly blend into the existing interface so that someone who didn’t already know would not realize that that thing there is not part of the basic system.

Therefore, if you have a plugin that has something to do with managing plugins, go ahead and put the screen under the Plugins menu. If it just has a basic settings screen, put it under Settings. If the screen lets the user manage something, then “Manage” is probably the right place.

I have a plugin that lets people easily put pull-quotes into a post. The admin screen for that plugin allows people to set options that control what the pull-quotes look like. Therefore I put the screen under “Design” (“Themes” in WP < 2.5) because it's primary function was to control the appearance of part of the blog. The Design menu is where it made the most sense.

So: Don’t make your plugin scream “this is a plugin” to the end user. If it were going to be part of core WordPress, what menu would you expect the screen to be under? Put it there.

(On a related note, the header on the top of your plugin’s page should not say “Such and Such Plugin” — it should just say “Such and Such”. I’ve seen some otherwise wonderful plugins made so that the header on the admin page is the file name. Yuck!)

Coming up next: How to put a direct link to your plugin’s admin screen on the Manage Plugins page.

This article was originally published at Nerdaphernalia. Planet WordPress is authorized to reproduce WordPress-related entries. If you're reading this at any other web site, the site owner is stealing copyrighted work. Please visit the original page:

Feed enhanced by Better Feed from Ozh