{"id":17885,"date":"2012-04-25T06:58:57","date_gmt":"2012-04-25T06:58:57","guid":{"rendered":"https:\/\/wordpress.org\/plugins-wp\/wp-shortcode-shield\/"},"modified":"2012-11-12T06:00:50","modified_gmt":"2012-11-12T06:00:50","slug":"wp-shortcode-shield","status":"publish","type":"plugin","link":"https:\/\/ur.wordpress.org\/plugins\/wp-shortcode-shield\/","author":70643,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_crdt_document":"","version":"1.1.0","stable_tag":"1.1.0","tested":"3.4.2","requires":"3.4","requires_php":"","requires_plugins":"","header_name":"WP ShortCode Shield","header_author":"Gary Gale","header_description":"","assets_banners_color":"f5f5f5","last_updated":"2012-11-12 06:00:50","external_support_url":"","external_repository_url":"","donate_link":"http:\/\/www.vicchi.org\/codeage\/donate\/","header_plugin_uri":"http:\/\/www.vicchi.org\/codeage\/wp-shortcode-shield\/","header_author_uri":"http:\/\/www.garygale.com\/","rating":5,"author_block_rating":0,"active_installs":10,"downloads":2646,"num_ratings":1,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","faq","changelog"],"tags":[],"upgrade_notice":{"1.1.0":"<p>Maintenance version; upgraded plugin to new version of WP_PluginBase to prevent class name clashes during future upgrades.<\/p>","1.0.1":"<p>Fixed a bug where WP_PluginBase is properly included and defined. This is the 2nd. version of WP Shortcode Shield.<\/p>","1.0":"<ul>\n<li>This is the first version of WP Shortcode Shield.<\/li>\n<\/ul>"},"ratings":{"1":0,"2":0,"3":0,"4":0,"5":"1"},"assets_icons":[],"assets_banners":{"banner-772x250.jpg":{"filename":"banner-772x250.jpg","revision":"536020","resolution":"772x250","location":"assets"}},"assets_blueprints":{},"all_blocks":[],"tagged_versions":["1.0","1.0.1","1.1.0"],"block_files":[],"assets_screenshots":{"screenshot-2.jpg":{"filename":"screenshot-2.jpg","revision":"1539234","resolution":"2","location":"plugin"},"screenshot-1.jpg":{"filename":"screenshot-1.jpg","revision":"1539234","resolution":"1","location":"plugin"}},"screenshots":{"1":"Raw Source Code Sample","2":"Resultant Content Display"},"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[6941,170,86,80],"plugin_category":[43],"plugin_contributors":[80526],"plugin_business_model":[],"class_list":["post-17885","plugin","type-plugin","status-publish","hentry","plugin_tags-documentation","plugin_tags-page","plugin_tags-post","plugin_tags-shortcode","plugin_category-customization","plugin_contributors-vicchi","plugin_committers-vicchi"],"banners":{"banner":"https:\/\/ps.w.org\/wp-shortcode-shield\/assets\/banner-772x250.jpg?rev=536020","banner_2x":false,"banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/s.w.org\/plugins\/geopattern-icon\/wp-shortcode-shield_f5f5f5.svg","icon_2x":false,"generated":true},"screenshots":[{"src":"https:\/\/ps.w.org\/wp-shortcode-shield\/trunk\/screenshot-1.jpg?rev=1539234","caption":"Raw Source Code Sample"},{"src":"https:\/\/ps.w.org\/wp-shortcode-shield\/trunk\/screenshot-2.jpg?rev=1539234","caption":"Resultant Content Display"}],"raw_content":"<!--section=description-->\n<p>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=\"http:\/\/codex.wordpress.org\/Shortcode_API\">WordPress ShortCode API<\/a> does not support nested shortcodes to allow this plugin's shortcode to wrap the shortcode being documented.<\/p>\n\n<blockquote>\n  <p>The shortcode parser uses a single pass on the post content. This means that if \n  the $content parameter of a shortcode handler contains another shortcode, it won't\n  be parsed<\/p>\n<\/blockquote>\n\n<p>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.<\/p>\n\n<p>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<\/p>\n\n<pre><code>[wp_scs code=\"[another-shortcode-name]\"]\n<\/code><\/pre>\n\n<p>... 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<\/p>\n\n<pre><code>[wp_scs code=\"another-shortcode-name\"]\n<\/code><\/pre>\n\n<p>... will display <em>[another-shortcode-name]<\/em> in your post's of page's content.<\/p>\n\n<p>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<\/p>\n\n<pre><code>[wp_scs][another-shortcode-name][\/wp_scs]\n<\/code><\/pre>\n\n<p>... and<\/p>\n\n<pre><code>[wp_scs]another-shortcode-name[\/wp_scs]\n<\/code><\/pre>\n\n<p>... will display the same results, namely <em>[another-shortcode-name]<\/em>.<\/p>\n\n<p>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=\"http:\/\/codex.wordpress.org\/Shortcode_API\">ShortCode API<\/a> ...<\/p>\n\n<blockquote>\n  <p>The parser does not handle mixing of enclosing and non-enclosing forms of the same\n  shortcode as you would want it to. For example, if you have:<\/p>\n  \n  <p><code>[myshortcode example='non-enclosing' \/] non-enclosed content [myshortcode] enclosed content\n  [\/myshortcode]<\/code><\/p>\n  \n  <p>Instead of being treated as two shortcodes separated by the text \" non-enclosed content \",\n  the parser treats this as a single shortcode enclosing \" non-enclosed content [myshortcode]\n  enclosed content\".<\/p>\n<\/blockquote>\n\n<!--section=installation-->\n<ol>\n<li>You can install WP Shortcode Shield automatically from the WordPress admin panel. From the Dashboard, navigate to the <em>Plugins \/ Add New<\/em> page and search for <em>\"WP Shortcode Shield\"<\/em> and click on the <em>\"Install Now\"<\/em> link.<\/li>\n<li>Or you can install WP Shortcode Shield manually. Download the plugin Zip archive and uncompress it. Copy or upload the <code>wp-shortcode-shield<\/code> folder to the <code>wp-content\/plugins<\/code> folder on your web server.<\/li>\n<li>Activate the plugin. From the Dashboard, navigate to Plugins and click on the <em>\"Activate\"<\/em> link under the entry for WP Shortcode Shield.<\/li>\n<li>That's it. There's no admin settings to configure. Go and start documenting.<\/li>\n<\/ol>\n\n<!--section=faq-->\n<dl>\n<dt>How do I get help or support for this plugin?<\/dt>\n<dd><p>In short, very easily. But before you read any further, take a look at <a href=\"http:\/\/www.vicchi.org\/2012\/03\/31\/asking-for-wordpress-plugin-help-and-support-without-tears\/\">Asking For WordPress Plugin Help And Support Without Tears<\/a> before firing off a question. In order of preference, you can ask a question on the <a href=\"http:\/\/wordpress.org\/support\/plugin\/wp-shortcode-shield\">WordPress support forum<\/a>; 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 <a href=\"http:\/\/twitter.com\/vicchi\">@vicchi<\/a>. 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.<\/p><\/dd>\n<dt>Is there a web site for this plugin?<\/dt>\n<dd><p>Absolutely. Go to the <a href=\"http:\/\/www.vicchi.org\/codeage\/wp-shortcode-shield\/\">WP Shortcode Shield home page<\/a> for the latest information. There's also the official <a href=\"http:\/\/wordpress.org\/extend\/plugins\/wp-shortcode-shield\/\">WordPress plugin repository page<\/a> and the <a href=\"http:\/\/vicchi.github.com\/wp-shortcode-shield\/\">source for the plugin is on GitHub<\/a> as well.<\/p><\/dd>\n<dt>I want to amend\/hack\/augment this plugin; can I do this?<\/dt>\n<dd><p>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.<\/p><\/dd>\n\n<\/dl>\n\n<!--section=changelog-->\n<p>The current version is 1.1.0 (2012.11.12)<\/p>\n\n<h4>1.1.0<\/h4>\n\n<ul>\n<li>Released 2012.11.12<\/li>\n<li>Other: Upgraded plugin to new version of WP_PluginBase to prevent class name clashes during future upgrades.<\/li>\n<li>Other: Ensure WP_ShortCodeShield is not already defined and instantiate as a singleton.<\/li>\n<li>Other: Rename misleading plugin constants (they're square brackets not angle brackets)<\/li>\n<\/ul>\n\n<h4>1.0.1<\/h4>\n\n<ul>\n<li>Released 2012.08.29<\/li>\n<li>Fixed: Ensure WP_PluginBase is properly included and defined.<\/li>\n<\/ul>\n\n<h4>1.0<\/h4>\n\n<ul>\n<li>Released 2012.07.17<\/li>\n<li>This is the first version of WP Shortcode Shield.<\/li>\n<\/ul>","raw_excerpt":"Allows posts and pages to easily document WordPress shortcodes without the shortcode being expanded.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/17885","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=17885"}],"author":[{"embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/vicchi"}],"wp:attachment":[{"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=17885"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=17885"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=17885"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=17885"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=17885"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/ur.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=17885"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}