vicchi

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 <a href="https://codex.wordpress.org/Shortcode_API" rel="nofollow ugc">WordPress ShortCode API</a> does not support nested shortcodes to allow this plugin’s shortcode to wrap the shortcode being documented.
<blockquote>
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
</blockquote>
The plugin supports both the self closing <code>[shortcode]</code> and enclosing <code>[shortcode]content[/shortcode]</code> forms and supports a short form name of the shortcode, <code>[wp_scs]</code> as well as the more verbose <code>[wp_shortcode_shield]</code> form. For the sake of brevity, the remainder of this documentation will use the <code>[wp_scs]</code> 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>code</code> attribute but without using the enclosing <code>[</code> and <code>]</code> 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
<pre><code>[wp_scs code="[another-shortcode-name]"]
</code></pre>
… WordPress will use the ‘]’ character inside the <code>code</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
<pre><code>[wp_scs code="another-shortcode-name"]
</code></pre>
… 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
<pre><code>[wp_scs][another-shortcode-name][/wp_scs]
</code></pre>
… and
<pre><code>[wp_scs]another-shortcode-name[/wp_scs]
</code></pre>
… 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 <a href="https://codex.wordpress.org/Shortcode_API" rel="nofollow ugc">ShortCode API</a> …
<blockquote>
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:
<code>[myshortcode example='non-enclosing' /] non-enclosed content [myshortcode] enclosed content 
 [/myshortcode]</code>
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”.
</blockquote>

WP Shortcode Shield

Allows posts and pages to easily document WordPress shortcodes without the shortcode being expanded.

Mark Jaquith

Site operators can create detailed, hierarchical documentation for the site’s authors, editors, and contributors, viewable in the WordPress admin. Powered by Custom Post Types, you get all the power of WordPress to create, edit, and arrange your documentation. Perfect for customized client sites. Never send another “here’s how to use your site” e-mail again!
NEW: You can now pull in help documents from another WP Help install, and they will be automatically updated when the source documents change (even additions and deletions!). Perfect for WordPress multisite installs, or consultants with a large number of client installs.

WP Help

I was going to write my own plugin, but then I found this one.

It's simple, effective and works well. The sync feature is especially useful in a multisite setup.

Thank you!

Easy and Effective

I create websites for clients. The plugin allows me to transfer documentation along with the site.
Simple and convenient. Thanks to the developer! 

P.S. Continue to develop the product.

Great plug-in. Create documentation in the admin panel.

Not much to say really. Simple. Does the job great. Been working without fail for many years.

Super plugin. Been using for years.


This is one of the best plugins you can find. Does what is says, clean and nice. The sync feature is just elegant, bust also very useful. Good for anyone, and a must have for agents and their clients.


Used for many years


For an agency delivering a lot of websites for users with little or no knowledge of WordPress, this is a gem!I can combine general docs from a central hub, so I only have to maintain it one place, with local docs for the customized functions.It's simple, but I can use most blocks in the help documents.


This is great!

Site operators can create detailed, hierarchical documentation for the site's authors, editors, and contributors, viewable in the WordPress admin …

WP Shortcode Shield vs WP Help