The Xavisys WordPress Plugin Framework

Aaron D. Campbell — Thu, 26 Nov 2009 02:16:18 +0000

A few months ago I was chatting with Joost de Valk and he was talking about a new plugin toolkit that he was making. The basic idea was to make a flexible base that he could use to build on for all his plugins. It would handle all the tasks that are common to all his plugins (options page, dashboard widget, etc) and still be easily extended so each plugin could handle more specific tasks as well. Now his plugins (at least some of them) use his toolkit.

It was a great idea, and I finally got around to writing one for my own plugins. I built it as an abstract class (and a tiny CSS file) that I extend for each plugin. Here you’ll get to see a quick tour of what the framework does. Let me know in the comments if you’re interested in seeing a walkthrough of how it was built, and feel free to download Efficient Related Posts to see it in action.

Here are some of the things it does:

Stores plugin settings in a protected variable, making them easily available to all methods.
Registers the options for the plugin (making sure it works in WPMU and that options.php can handle updates to the options).
When an update to the plugin is available, it shows a changelog from the currently installed version to the newly available version (whether they’re one version apart or twenty).
Adds an options page for the WordPress plugin settings, complete with a page heading and a Xavisys icon.
Styles the options page as two columns with meta boxes (similar to the two column dashboard layout).
Adds basic meta boxes to the sidebar of the options page, including one with a donate link, one with a link to the support forums, and one showing the latest news from Xavisys.
It adds links to the plugin row on the plugins page. One link to the support forums and one to the plugin options page.
It adds a dashboard widget with a feed from Xavisys, complete with the Xavisys logo and a way to subscribe via RSS to the Xavisys site.

It does all this based on variables set in the extending class. For example, the setup for Efficient Related Posts looks something like this:

require_once('xavisys-plugin-framework.php');
class efficientRelatedPosts extends XavisysPlugin {
	protected function _init() {
		$this->_hook = 'efficientRelatedPosts';
		$this->_file = plugin_basename( __FILE__ );
		$this->_pageTitle = __( 'Efficient Related Posts', $this->_slug );
		$this->_menuTitle = __( 'Related Posts', $this->_slug );
		$this->_accessLevel = 'manage_options';
		$this->_optionGroup = 'erp-options';
		$this->_optionNames = array('erp');
		$this->_optionCallbacks = array();
		$this->_slug = 'efficient-related-posts';
		$this->_paypalButtonId = '9996714';
	}
}

10 Great WordPress Plugins

Aaron D. Campbell — Thu, 12 Nov 2009 08:00:23 +0000

One of the greatest things about WordPress is how extensible it is through it’s plugin system. There’s a plugin for almost everything. There are more than 4,400 plugins just in the WordPress.org Plugin Directory and there are plenty more that aren’t in the directory. Unfortunately, sometimes there are so many plugins that it makes it hard to find the best WordPress plugins in the massive sea of options. Here are some of my favorite overall plugins.

Akismet

Akismet is the only useful plugin that ships with WordPress (so to speak). It requires that you sign up for an API key, but it’s well worth it. Comment spam is a huge problem on any site that allows comments. The WordPress Akismet plugin checks your comments against the Akismet web service to see if they look like spam or not and lets you review the spam it catches under your blog’s “Comments” admin screen. It’s actually quite effective, more than most (if not all) the other comment spam plugins I’ve tried.

Simple Trackback Validation

Fighting spam is the never ending task of anyone running a site that allows user content of any kind. Akismet does a great job of handling the comment spam, but Simple Trackback Validation fills in the gaps and handles trackbacks. Simple Trackback Validation Plugin performs a simple but very effective test on all incoming trackbacks in order to stop trackback spam. Basically, it makes sure that the page claiming to be posting a trackback actually links to the page it’s posting that trackback to.

Headspace2

WordPress is pretty good with search engine optimization right out of the box, just by turning on permalinks. However, there’s definitely plenty of room for improvement. HeadSpace2 is an all-in-one meta-data manager that allows you to fine-tune the SEO potential of your site. Headspace will help you to better handle your tags/keywords, meta descriptions, and it does a great job of cleaning up and customizing your title tag. No longer do you need a bunch of conditionals in your title tag. A simple wp_title(”) will suffice, and the rest can be handled by Headspace2.

Clean Slugs

Another plugin that will help you get a little better search engine optimization. Joost’s Clean Slugs plugin looks for and removes more than 650 “stop words” from your post or page title when the slug is created. These are words that most search engines ignore because they are inconsequential, so removing them will help your raking. Unlike all the other plugins on this list, this plugin can’t be downloaded from the WordPress.org repository. To get this plugin, simply sign up for Joost’s WordPress Newsletter.

Google XML Sitemaps

While it’s true that search engines can spider or crawl your site by following links, having a proper XML sitemap allows you to make sure that every post/page is properly indexed, as well as letting you specify a priority level for each. This plugin will create a Google sitemaps compliant XML-Sitemap of your WordPress blog. It supports all of the WordPress generated pages as well as custom ones. Everytime you edit or create a post, your sitemap is updated and all major search engines that support the sitemap protocol, like ASK.com, Google, MSN Search and YAHOO, are notified about the update.

Twitter Widget Pro

Twitter offer javascript widgets that display your latest tweets, but there are a couple problems. First, you need to be able to modify your theme or put the code into a text widget. Secondly, since it’s javascript, search engines don’t see the content. Twitter Widget Pro is a widget that properly handles twitter feeds, including @username and link parsing. It supports displaying profiles images, and even lets you control whether to display the time and date of a tweet or how log ago it happened (about 5 hours ago, etc). It does all this as a server-side widget, so the content can all be parsed by search engines. Requires PHP5.

WP Super Cache

WP Super Cache is a static caching plugin for WordPress. It generates html files that are served directly by Apache without processing comparatively heavy PHP scripts. By using this plugin you will speed up your WordPress blog significantly, reduce CPU/memory usage, and lessen database strain. If you have a high-traffic WordPress site, this is absolutely necessary.

Sociable

Social marketing is a hot topic and many have found that it’s incredibly successful. There are a few plugins for WordPress that will help you with this. Add This, Share This, and Sociable are the most popular, and I think Sociable is the best. It’s the only one that allows all content to be loaded from your site, no scipts or images to load from some other site. The reason this is so important to me is that I don’t ever want my site to load slowly because of a different site. Sociable automatically add links to your favorite social bookmarking sites on your posts, pages and in your RSS feed. You can choose from 99 different social bookmarking sites!

Subscribe to Comments

Getting people to comment on your posts can be a challenge. Even more difficult is getting people to come back to the same post and continue a discussion. Subscribe to Comments is a robust plugin that enables commenters to sign up for e-mail notification of subsequent entries. The plugin includes a full-featured subscription manager that your commenters can use to unsubscribe to certain posts, block all notifications, or even change their notification e-mail address!

Twitter Tools

Twitter Tools is a plugin that creates a complete integration between your WordPress blog and your Twitter account. The only part of it that I use is the ability to automatically notify Twitter of new posts. The problem is that it prefaces all these Tweets with “New blog post:” and this text isn’t customizable. Additionally, it uses tinyurl to shorten the URL for the post, and I would prefer that it let me use something like SnipUrl which lets me track the number of clicks. Still, the fact that it’s all automatic saves a lot of time for me, especially on sites like Web Developer News where people other than me post articles on a regular basis.

Xavisys» WordPress Plugins