How to add a custom button to the WordPress editor

While posting about my DrawBot adventures, I’ve become increasingly annoyed with my own post series WordPress plugin.  If only it had a simple button in the WordPress editor to drop the shortcode for an existing series, it would instantly become so much better.  Thus inspired, I delved into WordPress.org and sought out the answers.  What I discovered is that while it’s not particularly difficult to add a button to the WordPress text editor, it didn’t seem to be very well documented.  I’m still working on how to add a graphical button to the WordPress TinyMCE visual editor, so stay tuned for that.  I was ultimately able to glean the necessary information from the WordPress “Quicktags API.  However, for your sake1 I’m distilling what I’ve learned right here.

First, I’ll give you an overview of what we’re going to do.  If you’re looking to add a button to the WordPress editor, it’s probably because you’re working on a plugin.  Thus, I’ll assume you have a working knowledge of plugin development.   Your plugin will need to include, at a bare minimum, one action hook and one function which performs the double duty of creating the button and giving the button some kind of ability.

// This action adds a script to the script footer on administrative pages
add_action( 'admin_print_footer_scripts', 'MBSS_quicktags', 100 );

// This is the function that is run at the end of the administrative pages in the script footer
function MBSS_quicktags()
     {
     // Optional database interactions
     // I used this section in my plugin to run a query on the database and return information that would be used in the button
     ?>

     <script type="text/javascript">
     // Creates button in the text editor
     QTags.addButton( 'MBSS_tag_id', 'Add Series', MBSS_add_series_js );
     // Function to append the series shortcode to the end of the post
     function MBSS_add_series_js()
          {
          editor = document.getElementById('content');
          editor.value = editor.value + "\n" + "EXAMPLE TEXT TO APPEND TO END OF POST";
          }
     </script>
     <?php
     }

And there you have it! One action hook and one function which adds some javascript magic to your WordPress editor in the form of a simple text editor button!

Default Series Title
  1. And, frankly, for my own future use []

Simple Series WordPress Plugin Update

Making cereals
Making cereals

This weekend, almost an entire year from the last update, I made some revisions to my Simple Series plugin for WordPress.1 This is one of the plugins that I use the most often for WordPress.  It’s right up there, in terms of frequency, with the WP-Footnotes plugin that lets me insert footnotes.2

As much as I loved this plugin, it was always a little bit of  pain to use.  In order for two posts to be associated together in the same series, the title must be listed exactly the same in each post.  So, to make sure that I was getting it right, I would open an old post in the relevant series, copy the exact plugin shortcode with the exact title, and paste it into the new post.

With this update you can click the “Add Series” button in the TinyMCE text editor for a post and insert any series title you’ve previously used.  It’s not yet as elegant as I would like, but it makes a few button clicks out of a what used to be an annoying process.3 I’ve also added the ability to have a series between pages, posts, or any combination of the two kinds of content types.

Default Series Title
  1. Photo courtesy of Tavo []
  2. Like this! []
  3. Described in the prior paragraph []

Plugin Considerations

When designing/writing software, or I suppose any kind of engineering for that matter, there is always a tension between features and complexity.  I really want this Simple Series WordPress plugin to be simple and easy to use.  But, as I use it more and more I find there are some possible features that I wouldn’t mind having.

For example, my DrawBot series is at 43 posts at this moment.  The problem is that each post, no matter how short, now has an entire screen-length’s worth of a list for the series. 1  Now, there are several possible ways to handle this:

  • I suppose when I’m looking to design a UI, the most important things to focus on is what would the user expect to see and happen.  It certainly makes sense for there to be a uniform series list in every post.  But, it seems slightly inelegant to have it that way for every single post when you’re looking at an entire page.
  • I could modify the plugin so that it would only create a list once per page, rather than once per post.  I suppose subsequent instances could then provide a single link to the series list in the initial post.  I think this would be non-intuitive as a person navigated the page.
  • I could modify the plugin so that it only showed the current post plus X posts before and after where X is some arbitrary number I choose.  (Although, I’d probably make it user specifiable).  I’d have to dig into some fancy scmancy CSS to define a different start-number for the HTML ordered list, but this isn’t a huge problem.  Ideally, it would say there are Y prior posts and Z subsequent posts as well.  Then again, it is really helpful (at least to me) to be able to click back up or down through a series list.

Perhaps the optimal result is something in between?

  • On a page consisting of a single post, the entire list should be displayed.
  • On a page consisting of multiple posts, the subsequent lists should be truncated in some meaningful fashion.  Perhaps the last and subsequent X posts, with a little sentence indicating Y more prior posts and Z more subsequent posts.  When you click on the “Y more prior posts” it could take you to the first instance of the series list on that page and when you click on the “Z more subsequent posts” it could take you to the next post listed in the series on the first instance of the series list on that page. 2
  • Sadly, this system would not really change much for the RSS feed readers.
Default Series Title
  1. I can’t even imagine how much text is devoted to just the series list on those DrawBot posts in your RSS feed. []
  2. Um.  This sounded a lot clearer in my head as I typed it than it probably reads. []

Simple Series – Half-Life; Market Research

I’m wondering at what point will the downloads on this plugin plateau.  Whatever the eventual baseline download rate, I would suspect that speaks to the amount of maximum market share that is possible for a plugin that performs these functions.1  I would think that downloads would spike when I release a new version of the plugin.  Given that I released about five updates to this plugin the first day, I would assume some of those initial downloads were duplicative.

As far as rankings go, at this time this plugin is #5 on WordPress.org’s plugin search page, #5 inside WordPress’s internal “Add New” plugins search page, and no where to be seen in the Google rankings.  Looking at Google Keywords, it appears that there’s no small amount of search traffic for the keywords “WordPress series.”  There’s some 200,000 global monthly searches.  One of the reasons I’m following this so closely is that I’ve had a few ideas for plugins that I could sell.2

Here’s the WordPress.org plugin download stats for “Simple Series with SEO!” for the first four days.

  1. 1/26/2012: 1 download
  2. 1/27/2012: 99 downloads
  3. 1/28/2012: 37 downloads
  4. 1/29/2012: 20 downloads

What will tomorrow bring?

Default Series Title
  1. I promise I won’t subject your RSS feed to my obsessive stats checking.  Much of the time I use this blog as a way to document/save/organize information that is probably really only interesting to me. []
  2. A brother’s gotta earn, right? []

Anti-Virals

Here’s the WordPress.org plugin download stats for “Simple Series with SEO!” for the first three days.

  1. 1/26/2012: 1 download1
  2. 1/27/2012: 99 downloads2
  3. 1/28/2012: 37 downloads3

It looks after being bumped from the newest plugins slot, the downloads dropped precipitously.  So much for going viral, money, and fame, eh?

Actually, I’m happy to have helped out a 100 people or so.  I also think a lot more people will end up using this plugin over time.  The alternatives, while very good, are more difficult to use and do tend to add a lot of other stuff into your WordPress installation.

Default Series Title
  1. That was me installing it in another blog! []
  2. And a blog ain’t one []
  3. I have nothing clever to say about this. []

Simple Series with SEO! after just one day

I’m really happy to report that per the WordPress.org stats, this little post series plugin has been downloaded more than 100 times so far.  That’s really awesome.  And, now that I’ve figured out how to work this wacky SVN thing, I think it would be fun to release some of the other random little plugins I’ve developed over the last few years.

As of the latest version 1.4, the plugin is now easy to modify with some CSS added to your stylesheet.  I could have added this as a text field option a settings page for the plugin, but I really like the stripped down simplicity of the plugin as is.  Even with all the comment lines in the plugin, it is only 53 lines of code.  If super short code were a goal1 I could probably cut that in half.2

Now I have to find some of my old plugins that others might find useful.  I’ve got one for frame escaping, one for making pie charts…  I know there are a few other random ones as well.

Default Series Title
  1. And it isn’t []
  2. Obviously, I’m not going to do this since it would make the code next to illegible []

This is a test of the Simple Series post system… This is only a test

This is really just to see if I’ve solved the “Hey!  The series link doesn’t show up in my RSS feed” problem. 1

Default Series Title
  1. Thanks for telling my Dna! []

My first published WordPress plugin! Simple Series!

This may seem silly, but I’m really happy with having published my very first plugin on WordPress.org.

My Simple Series plugin lets you easily create and helps you automatically maintain a list of posts.  I started writing this plugin because all of the existing ones seemed really clunky and over-engineered.  There’s no need for extra tables in WordPress, brand new taxonomies, or special system requirements.  If you can fire up any recent version of WordPress, you should be able to use this plugin without a problem. 1

As much of a WordPress fanboy as I am, I’ve never actually shared a plugin on the WordPress.org repository.  It was simultaneously easier and more difficult than I thought it would be.  The page that discusses how you can contribute your plugin and talks about “checking out” files makes absolutely no mention of how you’re supposed to do this!

Apparently you require a program to connect to the WordPress SVN to check out the file and commit changes.  On the advice of Schmarty I’m using TortoiseSVN.  Once that was installed and a sub-directory selected, it was relatively easy to commit changes.  If you haven’t tried it before, this whole SVN thing feels like a clunky slow version of FTP.

Default Series Title
  1. Of course, now people are going to start e-mailing me with problems… []

Simple Series WordPress Plugin

I’ve written a new WordPress plugin specifically designed to let you simply and easily create a series of related posts.  You can download Simple Series here.

What does “Simple Series” do?

Simple Series uses a WordPress shortcode to associate your posts together.  All you have to do is use the same shortcode in all of the posts you want to associate together and the plugin does the rest.  It will automatically find all of the posts with the same shortcode, organize them by publication date, and put them together in a professional and easy to read format.  If you wish to change the format, you can just add your own custom CSS to your theme.

How does “Simple Series” work?

Easy!  Just add the shortcode to each of the posts you want to put in the series.  Inside the shortcode you will need to specify the title for the series.  Like so:

Default Series Title

What if I add more posts later?

No problem!  The “Simple Series” plugin will always update the series lists in each of your posts whenever you publish a new post.  The newest post will always be added to the series in chronological order, by publication date.  You can see an example of what it looks like here in my own DrawBot series.

I have more questions!

Cool!  Please leave a comment to this post or send me an e-mail!

Default Series Title

A nifty little WordPress plugin…

The idea for this little plugin has been rattling around in my head for a little while now.  It clocks in at less than 60 lines of code, including comments, and makes it easy to create a “series” for posts.

As I’ve been blogging about my (mis)adventures in building a DrawBot, I’ve been updating each post to contain a link back to all of the prior posts in the series.  However, if someone were to find one of the first posts – they wouldn’t see a link to a later post.  That is, unless I update all the posts.  That’s not really much of an option, since I’ve racked up 23 posts in less than 19 days. 12

This plugin is actually super simple.  Here’s what it does:

  1. Add a “post meta” tag for the current post with the same key as whatever you want to name the post series
  2. Query the database for all posts with the same post meta key as the one for the current post
  3. Output an ordered chronological list of all posts in with the same post meta key as the one for the current post

The simplicity of this plugin are actually some of it’s strongest features.  Unlike a lot of other series plugins out there, it doesn’t create any unnecessary tables in your WordPress database.  There are no settings to mess with, no CSS to fiddle with, no ugly standard formatting to overcome.

The only downside I can perceive is that if you delete the shortcode from a plugin, it will still leave the post-meta attached to the post and the post will still appear in the series.  If you leave the shortcode in and don’t specify a series title, it will delete the post-meta.  I suppose I could include a little button in the interface to delete the post from the series, but really, it’s just not going to be used that often.

Anyhow, this is something that I’ve wanted to have for a long time – I just hadn’t gotten around to building it yet.

Default Series Title
  1. I’ve got a lot to say. []
  2. And, actually, that’s just 23 posts on this one topic.  I’ve probably blogged an equal amount over on the MakerBot blog, with a few totally random additional posts here. []