Hacking it might be better than ignoring it.

One of the cool features of the Dashboard and administration panels in the current version of WordPress is its reminders of comments awaiting modification and plugins requiring update. You’ll see the reminders as numbers inside red circles. The one shown here, for example, is telling me that one of my installed plugins has an update available.

Clicking the Plugins button on the administration panel’s navigation bar displays the details. In this case, it’s a list of plugins, with a yellow bar indicating the available update:

If you’ve been following the posts about WordPress on this site, you might recall that I had a problem with this particular plugin, Landing Sites. In fact, I’d already updated it on my blog and discovered that the update didn’t work. So I’d reinstalled the older version. As a result, WordPress is no nagging me to update to a version I don’t want to use.

A stronger person would simply ignore the update flag. But why do that if you can turn the flag off for this plugin?

Here’s the trick.

1. Use WordPress’s built-in plugin editor to open the plugin file you don’t want to update for the current version.
2. Locate the line near the beginning that begins with the word Version: and includes the current version number. Here’s what it looks like for the plugin I’m hacking:
   
3. Replace the version number with the current version number. So, in this example, I’d replace 1.3 with 1.4.1.
4. You can then get a bit fancy and modify the Description area to note the real version number, just in case you forget. This information will appear on the Manage Plugins administration panel as a reminder. Here’s what my fully edited Description and Version look like:
   
5. Click the Update File button to save your changes.

If you did all of this right and didn’t edit something you shouldn’t have, WordPress will think you have the current version of the plugin installed and the reminder icon will go away. As shown here, the version number and description in the Manage Plugins administration panel will reflect your changes.

Best of all, if another update comes out, WordPress will still notify you about it.

When updates go wrong.

Way back in 2006, I wrote an article titled “Reader Engagement Site Improvements.” In it, I detailed a number of plugins I’d installed to help keep visitors around a while longer, looking at new content on my site.

One of these plugins is called Landing Sites. Its job is to check to see if a visitor has arrived (or “landed”) on your blog from a search engine it knows. If it has, it displays a custom message with links to possibly related posts. The idea is that if a visitor has come to your site because he was searching for something, maybe one of your other related posts might meet his needs. Here’s what it looks like on my blog, with some customization.

I used the plugin on both my main blog, An Eclectic Mind, and this Maria’s Guides site. It worked like a charm. My blog was even commended by another blogger for the use of this feature. (Wish I could find the link, but I can’t. Sorry.)

Then, I made a fatal error. When WordPress notified me that the Landing Sites plugin had been updated from version 1.3 to 1.4.1, I allowed it to automatically install the update. I didn’t realize until I updated my blog to WordPress 2.7 and changed the theme that Landing Sites had stopped working. Instead of showing a list of related posts, it was show some raw and ugly PHP code.

I figured the problem was with WordPress 2.7, so I just disabled it on my blog. I posted a comment in a WordPress.org support thread and waited for a response. The author of the plugin subsequently posted instructions for a fix, but it didn’t work for me or for others.

Today, Lorelle (of Lorelle on WordPress fame) e-mailed me to point out that the plugin wasn’t working on this site. (I admit it: I’m lazy and still have this site set up on WordPress 2.6.5.) That surprised me. I went into action, beginning the troubleshooting process.

No fix worked. But I was able to track down the old version of the plugin. I disabled the current version and deleted it. Then I reinstalled the old version (1.3) and activated it. The result: problem solved.

I then went to my blog, which is running WordPress 2.7, and installed the old version there. As you can see from the screenshot above, it works.

What does this mean to self-hosted WordPress users? Unfortunately, it means that plugin updates don’t always make things work better — or even right. In this instance, the plugin author “broke” the plugin by trying to fix it and releasing an update. I don’t know if the new version works for everyone else, but I know it doesn’t work for me. I don’t know why, and frankly, I don’t care. I’m just glad that reinstalling the old version fixed the problem.

I like the plugin and am glad to have it fully functional on my blogs.

A big thanks to Lorelle for contacting me when she found the problem. Since I never reach my blogs via a search engine, I probably never would have found the problem on my own.

One of the great new features of WordPress 2.5.

One of the challenges of keeping a WordPress blog running smoothly is making sure all installed plugins are updated promptly when new versions become available. WordPress 2.5 makes this easier than ever by adding an Automatic Upgrade feature.

As shown in the following illustration, the a note in the Plugin Management administration panel indicates that the Bad Behavior plugin (which I rely on to keep the spambots off my blogs) has been updated.

I have two options for bringing my blog up to date:

• Download version takes me to the Bad Behavior page on the WordPress.org’s Plugin Directory so I can read about and download the update. This functionality has been around for a while — at least since WordPress 2.3 — with all plugins that support it.
• Upgrade automatically takes the update process a step further. When I click this link, WordPress automatically downloads, uncompresses and installs the new version of the plugin for me. It displays its progress as it works, as shown here, and confirms that the upgrade has been successful.

I’ve been using this new feature for a few weeks now and it’s worked like a charm. It’s a heck of a lot easier than upgrading the old fashioned way.

One of the first steps to upgrading.

WordPress 2.1 is out and its a major upgrade to what I believe is the best blogging platform. But your decision to upgrade should be based, in part, on whether you can make good use of the new features. (You can learn more about what’s new on the WordPress.org Web site.) But that’s not all that should be considered when making the upgrade decision. What might be more important is the amount of work your blog may need to complete the upgrade.

Before I launch into my discussion of plugin compatibility as it applies to the upgrade, let me make a clear distinction between the two groups of WordPress users. If you’re using WordPress with a WordPress.com account, you don’t need to worry about upgrading the software. The folks who manage WordPress.com will do it for you and you’ll see the new features online. But if you’re running WordPress on your own server or on a hosted server, you have a bit of work ahead of you to complete the upgrade. This article is for you.

Why Care?

I operate six WordPress-based blogs on a hosted server account. Most of them are “mission-critical,” meaning they could cause loss of business if they were to become unavailable. So I can’t take a major upgrade lightly. That’s why I’m thinking through the upgrade for each site, one at a time, before actually moving forward.

(I do want to mention that if you follow the instructions on the Upgrade page, if the upgrade goes bad, you can always go back to the site the way it was before the upgrade. That’s why its vital to follow the upgrade instructions.)

Types of Plugins

Some of my sites make extensive use of plugins. The way I see it, there are four types of plugins, each of which I’ve given an unofficial label:

• Simple plugins don’t require any template file modifications and don’t make changes to the way you work with your blog. You just install the plugin, activate it, and it works. Examples of simple plugins include Hello Dolly and No Self Pings.
• Set-It-and-Forget-It plugins are one step above simple plugins. They don’t require any template changes and don’t make changes to the way you work with your blog, but they do offer an administration panel for setting options. Examples include Bad Behavior, Spam Karma, Random Header, and WP-Cron (with WordPress Database Backup).
• Entry Utility plugins are plugins that change the way your create entries or display them online. These plugins don’t require you to modify your template file(s), but they may change the way you compose blog entries by offering additional options or change the way entries appear online. Some examples include Adhesive, Simple Tags, and WP-Contact Form.
• WordPress Feature Extension plugins are those that require modification of your blog’s template files to add plugin-specific tags. In many cases, these tags add impressive new features to the site that go far beyond WordPress’s feature set. Some examples include Customizable Post Listings, Landing Sites, and WP-Print, just to name a few. This is by far the biggest group of plugin types and, as you’ll see in a moment, it’s the group that’s most likely to cause problems in the event of an incompatibility.

The upgrade instructions recommend that you disable all plugins before completing the upgrade. With the first three types of plugins, that should be no problem. But with plugins that require modification of your theme files to accommodate plugin-specific tags, turning off the related plugin could result in PHP errors or other problems when the page is loaded. If you don’t turn off the plugin and upgrade and the plugin is not compatible with WordPress, you could wind up with PHP errors, too.

Which Plugins are Compatible?

My advice is to make a full assessment of your plugin situation before beginning the upgrade. Here’s how:

1. Go to your Plugins Management page (/wp-admin/plugins.php from your blog’s main directory; click the Plugins button in the Dashboard or any other administration panel) and make a list all plugins that are installed and activated, as well as any that are installed and disabled but might be activated in the future.
2. Compare the plugins on the list to the WordPress 2.1 Plugin Compatibility page.
3. Check off all plugins on your list that are known to be compatible. These are the ones you won’t have to worry much about.
4. Circle all plugins on your list that are known to be incompatible. These are the ones that will need to be permanently disabled. If they are WordPress feature extension plugins (as defined above), you’ll have to find and remove related tags that you may have inserted in your template files.
5. Put a star beside all plugins on your list that are either not listed on the Compatibility page or are lists with unknown compatibility. These are the ones you’ll have to watch.

Proceed with Caution

There are two ways to insert plugin-specific code in your WordPress blog:

• With If-Then logic uses PHP IF statements to determine whether a plugin’s function exists — in other words, if the plugin is enabled and its code is accessible by WordPress — and, if it does, allows WordPress to access the code. Here’s an example I use in my sidebar with Readers Post:

  <?php if (function_exists('last_posts')): ?>
  
  <?php last_posts(8); ?>
  
  <?php endif; ?>

• Without If-Then logic simply inserts the code without any test to see if the function called is available. For example:

  <?php last_posts(8); ?>

You should be able to see which one is safer — the first one. If your template files include plugin-specific code with if-then logic, when you disable your plugins, your blog pages will continue to display without the plugin-specific content or PHP errors.

My advice, therefore, is to go through all your template files and modify plugin-specific code to include if-then logic as illustrated above. This will make it far easier to disable all plugins before the upgrade and turn them back on, one at a time, when the upgrade is finished — as recommended in the Upgrade instructions document.

A Final Word of Advice

While the new features of WordPress 2.1 sound great and you may feel as if you just “can’t wait” to upgrade, don’t just dive in. Think things through. If you have multiple WordPress blogs, perform the upgrade on the blog that’s the simplest, with the least template modifications, and the least “importance.” Follow the upgrade instructions carefully. And be prepared to restore to your current version of WordPress if you need to.

More upgrade tips to come. Keep checking in.