At Long Last – Arconix Shortcodes v1.1

It’s been a while since I’ve updated my shortcodes plugin, and I spent this latest release primarily adding user-requested features. One of the most requested enhancements for this round was adding a compatibility mode to the plugin. With all the other plugins and themes in the WordPress universe that happen to use the same shortcode names as my plugin, a compatibility mode would allow similarly named shortcodes to coexist in peace. Turning on compatibility mode is very easy. Just a simple line added to your theme’s functions.php file

define( 'ACS_COMPAT', true ); // Arconix Shortcodes Compatibility Mode

That will prefix all shortcodes with ac-. For example, if I wanted to use the box shortcode, instead of using [ box ]My box content[ /box ], I’ll use [ ac-box ]My box content[ /ac-box ].

This does not change any existing shortcode text, so if you’re turning on compatibility mode after you’ve already been using this plugin, you’ll need to edit the posts/pages, etc… and rename the shortcodes to the proper name.

The other big user-requested item was adding some other way to remember all the shortcodes instead of always having to load the documentation. The result of this is I’ve added a meta box to the post and page edit screens that lists all the shortcodes. That list also honors the compatibility mode setting, so it will display those shortcodes correctly if you’ve turned compatibility mode on. If you’d like to add that meta box to other content types that you may have enabled on your website, that list can be modified with a filter.

The other two updates are minor for most people, but anyone who needs to override the version of the jQuery Tools script will appreciate that instead of having to modify core plugin files (and re-modify them when I update the plugin), they can do so through their functions file and not worry about it breaking in the future. The other update was for anyone that likes to peek around the source code and see how it all works — I’ve heavily updated the inline documentation, and while it may not be perfect, it’s a lot better and should be much easier to follow.

As usual, let me know what you think or if you run into any issues.