WP Shortcode Shield – Helping To Document WordPress Shortcodes

What Is WP Shortcode Shield?

WP Shortcode Shield is a WordPress plugin to allow posts and pages to easily document WordPress shortcodes without the shortcode being expanded.

What Does It Do?

This plugin allows you to refer to a WordPress shortcode within the content of posts and pages without that shortcode being automagically expanded by WordPress. The plugin takes advantage of the fact that the WordPress ShortCode API does not support nested shortcodes to allow this plugin’s shortcode to wrap the shortcode being documented.

The shortcode parser uses a single pass on the post content. This means that if the $content parameter of a shortcode handler contains another shortcode, it won’t be parsed

The plugin supports both the self closing [shortcode] and enclosing [shortcode]content[/shortcode] forms and supports a short form name of the shortcode, [wp_scs] as well as the more verbose [wp_shortcode_shield] form. For the sake of brevity, the remainder of this documentation will use the [wp_scs] short form name.

If using the self-closing form of the shortcode, you need to supply the name of the shortcode you are documenting using the code attribute but without using the enclosing [ and ] characters. This is because when parsing shortcodes, WordPress looks for the first occurrence of the ‘]’ character to terminate the shortcode. As a result of this, usage such as

[wp_scs code="[another-shortcode-name]"]

… WordPress will use the ‘]’ character inside the code attribute to try and terminate the shortcode name, which is not what is desired. Instead, the plugin automagically adds the terminating ‘[' and ']‘ characters to the plugin’s output, so that usage such as

[wp_scs code="another-shortcode-name"]

… will display [another-shortcode-name] in your post’s of page’s content.

If you are using the enclosing form of the shortcode, you can either supply the shortcode to be documented with or without enclosing ‘[' and ']‘ characters; if they are omitted, the plugin will add them for you, so that usage such as

[wp_scs][another-shortcode-name][/wp_scs]

… and

[wp_scs]another-shortcode-name[/wp_scs]

… will display the same results, namely [another-shortcode-name].

Finally a note of caution, you cannot mix the enclosing and self closing form of the plugin’s shortcode within the same post or page; this is not a limitation of the plugin, but the way in which WordPress implements the ShortCode API

The parser does not handle mixing of enclosing and non-enclosing forms of the same shortcode as you would want it to. For example, if you have:

[myshortcode example='non-enclosing' /] non-enclosed content [myshortcode] enclosed content[/myshortcode]

Instead of being treated as two shortcodes separated by the text “non-enclosed content”, the parser treats this as a single shortcode enclosing “non-enclosed content [myshortcode]enclosed content”.

How Do I Download WP Shortcode Shield?

To download or install WP Shortcode Shield on your WordPress powered site, either search for WP Shortcode Shield from the WordPress Dashboard or go to plugin’s page on the official WordPress plugin repository.

If you want to fork the source code of the plugin, you can find it on the plugin’s GitHub page at https://github.com/vicchi/wp-shortcode-shield.

What’s New?

WP Shortcode Shield v1.1 was released 11/11/12.

Full Documentation

Installation

  1. You can install WP Shortcode Shield automatically from the WordPress admin panel. From the Dashboard, navigate to the Plugins / Add New page and search for “WP Shortcode Shield” and click on the “Install Now” link.
  2. Or you can install WP Shortcode Shield manually. Download the plugin Zip archive and uncompress it. Copy or upload the wp-shortcode-shield folder to the wp-content/plugins folder on your web server.
  3. Activate the plugin. From the Dashboard, navigate to Plugins and click on the “Activate” link under the entry for WP Shortcode Shield.
  4. That’s it. There’s no admin settings to configure. Go and start documenting.

Screenshots

Raw Source Code Sample

Resultant Content Display

Frequently Asked Questions

How do I get help or support for this plugin?

In short, very easily. But before you read any further, take a look at Asking For WordPress Plugin Help And Support Without Tears before firing off a question. In order of preference, you can ask a question on the WordPress support forum; this is by far the best way so that other users can follow the conversation. You can ask me a question on Twitter; I’m @vicchi. Or you can drop me an email instead. I can’t promise to answer your question but I do promise to answer and do my best to help.

Is there a web site for this plugin?

Absolutely. Go to the WP Shortcode Shield home page for the latest information. There’s also the official WordPress plugin repository page and the source for the plugin is on GitHub as well.

I want to amend/hack/augment this plugin; can I do this?

Totally; this plugin is licensed under the GNU General Public License v2 (GPLV2). See http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt for the full license terms.

What’s Changed?

v1.1.0 – 2012.11.11

  • Other: Upgraded plugin to new version of WP_PluginBase to prevent class name clashes during future upgrades.

v1.0.1 – 2012.08.29

  • Fixed: Ensure WP_PluginBase is properly included and defined.

v1.0 – 2012.07.17

  • This is the first version of WP Shortcode Shield.