Provides a [shortcode] shortcode to allow you to show shortcode usage examples without the shortcodes being processed
|Author:||cubecolour (profile at wordpress.org)|
|WordPress version required:||3.5|
|WordPress version tested:||5.0.0|
|Added to WordPress repository:||04-03-2014|
|Total downloads:||1 215|
Click to start download
Enter the shortcode shortcode in the text editor, style the shortcode example by adding a CSS rule to the child theme (optional). The shortcode shortcode displays on the frontend with your styling.
What is the syntax of the shortcode for displaying an example of a shortcode?
If you are writing about the native WordPress shortcode and want to describe how to use the shortcode, you would include this in your text as:
When the shortcode is displayed on the frontend it is within a span with the ‘shortcode’ class so you can target it in your child theme stylesheet.
Why would I need this plugin?
You might find this plugin useful if you are documenting or reviewing WordPress plugins and need to show the shortcode syntax without the shortcode being processed by WordPress – which would happen if you have the plugin you are writing about installed on your site.
If you don’t write about WordPress shortcodes on your site you probably won’t gain any benefit from this plugin.
Couldn’t I just use use the html entities to write the shortcode syntax instead of this plugin?
Yes, you could. You can use the html entities [ for the left square bracket and ] for the right square bracket. However I wouldn’t recommend this approach. If you do this and later switch between the text editor and the visual editor, the html entities will be replaced with the square brackets characters resulting in the shortcodes being processed. I created the plugin after I had this happen on one of my own sites.
You could also add zero-width spaces: ​ after the opening square bracket and before the closing square bracket to prevent the shortcodes being processed, however I wouldn’t recommend this approach either because people reading your post might copy & paste your example code directly into their own site, and when they do, instead of a working shortcode they will get the version with a zero width space in it, and the shortcode won’t work for them. When this occurs the zero width space character is invisible so it can be difficult to troubleshoot.
Doesn’t WordPress already do this natively with the double bracket syntax?
Yes and if that works for you, you don’t need this plugin, you could just escape the shortcode by enclosing it in additonal square brackets eg: [gallery] which will display as the drawback to this is that if you later deactivate the plugin or theme providing the shortcode, both sets of square brackets will be shown.
I am using the plugin and it has saved me time and/or hassle; how can I show my appreciation?
You can donate via my donation page
If you find the plugin useful I would also appreciate a review on the plugin review page page.
Why is it not working for me?
If the plugin isn’t working for you, please read all of the documentation again. If this doesn’t help, check the posts on the plugin’s forum to see if your issue has already been covered there. If you still have a problem, please post a question on the plugin support forum
If you do have a problem, don’t leave a review before posting your problem on the support forum first.
- Initial Version