{"id":20747991,"url":"https://github.com/vicchi/wp-shortcode-shield","last_synced_at":"2026-04-19T22:31:09.462Z","repository":{"id":3098771,"uuid":"4124074","full_name":"vicchi/wp-shortcode-shield","owner":"vicchi","description":"WordPress plugin to allow posts and pages to easily document WordPress shortcodes without the shortcode being expanded.","archived":false,"fork":false,"pushed_at":"2012-11-12T05:53:36.000Z","size":580,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-26T10:47:09.442Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vicchi.png","metadata":{"files":{"readme":"readme.txt","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-04-24T11:52:24.000Z","updated_at":"2013-10-14T04:06:12.000Z","dependencies_parsed_at":"2022-09-22T15:01:44.114Z","dependency_job_id":null,"html_url":"https://github.com/vicchi/wp-shortcode-shield","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/vicchi/wp-shortcode-shield","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vicchi%2Fwp-shortcode-shield","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vicchi%2Fwp-shortcode-shield/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vicchi%2Fwp-shortcode-shield/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vicchi%2Fwp-shortcode-shield/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vicchi","download_url":"https://codeload.github.com/vicchi/wp-shortcode-shield/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vicchi%2Fwp-shortcode-shield/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32025545,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T20:23:30.271Z","status":"online","status_checked_at":"2026-04-19T02:00:07.110Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T08:14:59.054Z","updated_at":"2026-04-19T22:31:09.427Z","avatar_url":"https://github.com/vicchi.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"=== WP Shortcode Shield ===\nContributors: vicchi\nDonate link: http://www.vicchi.org/codeage/donate/\nTags: page, post, shortcode, documentation\nRequires at least: 3.4\nTested up to: 3.4.2\nStable tag: 1.1.0\nLicense: GPLv2 or later\nLicense URI: http://www.gnu.org/licenses/gpl-2.0.html\n\nAllows posts and pages to easily document WordPress shortcodes without the shortcode being expanded.\n\n== Description ==\n\nThis 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](http://codex.wordpress.org/Shortcode_API) does not support nested shortcodes to allow this plugin's shortcode to wrap the shortcode being documented.\n\n\u003e The shortcode parser uses a single pass on the post content. This means that if \n\u003e the $content parameter of a shortcode handler contains another shortcode, it won't\n\u003e be parsed\n\nThe 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.\n\nIf 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\n\n`[wp_scs code=\"[another-shortcode-name]\"]`\n\n... 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\n\n`[wp_scs code=\"another-shortcode-name\"]`\n\n... will display *[another-shortcode-name]* in your post's of page's content.\n\nIf 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\n\n`[wp_scs][another-shortcode-name][/wp_scs]`\n\n... and\n\n`[wp_scs]another-shortcode-name[/wp_scs]`\n\n... will display the same results, namely *[another-shortcode-name]*.\n\nFinally 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](http://codex.wordpress.org/Shortcode_API) ...\n\n\u003e The parser does not handle mixing of enclosing and non-enclosing forms of the same\n\u003e shortcode as you would want it to. For example, if you have:\n\u003e\n\u003e `[myshortcode example='non-enclosing' /] non-enclosed content [myshortcode] enclosed content\n\u003e [/myshortcode]`\n\u003e\n\u003e Instead of being treated as two shortcodes separated by the text \" non-enclosed content \",\n\u003e the parser treats this as a single shortcode enclosing \" non-enclosed content [myshortcode]\n\u003e enclosed content\".\n\n== Installation ==\n\n1. 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.\n1. 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.\n1. Activate the plugin. From the Dashboard, navigate to Plugins and click on the *\"Activate\"* link under the entry for WP Shortcode Shield.\n1. That's it. There's no admin settings to configure. Go and start documenting.\n\n== Frequently Asked Questions ==\n\n= How do I get help or support for this plugin? =\n\nIn short, very easily. But before you read any further, take a look at [Asking For WordPress Plugin Help And Support Without Tears](http://www.vicchi.org/2012/03/31/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](http://wordpress.org/support/plugin/wp-shortcode-shield); 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](http://twitter.com/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.\n\n= Is there a web site for this plugin? =\n\nAbsolutely. Go to the [WP Shortcode Shield home page](http://www.vicchi.org/codeage/wp-shortcode-shield/) for the latest information. There's also the official [WordPress plugin repository page](http://wordpress.org/extend/plugins/wp-shortcode-shield/) and the [source for the plugin is on GitHub](http://vicchi.github.com/wp-shortcode-shield/) as well.\n\n= I want to amend/hack/augment this plugin; can I do this? =\n\nTotally; 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.\n\n== Screenshots ==\n1. Raw Source Code Sample\n1. Resultant Content Display\n\n== Changelog ==\n\nThe current version is 1.1.0 (2012.11.12)\n\n= 1.1.0 =\n* Released 2012.11.12\n* Other: Upgraded plugin to new version of WP_PluginBase to prevent class name clashes during future upgrades.\n* Other: Ensure WP_ShortCodeShield is not already defined and instantiate as a singleton.\n* Other: Rename misleading plugin constants (they're square brackets not angle brackets)\n\n= 1.0.1 =\n* Released 2012.08.29\n* Fixed: Ensure WP_PluginBase is properly included and defined.\n\n= 1.0 =\n* Released 2012.07.17\n* This is the first version of WP Shortcode Shield.\n\n== Upgrade Notice ==\n\n= 1.1.0 =\nMaintenance version; upgraded plugin to new version of WP_PluginBase to prevent class name clashes during future upgrades.\n\n= 1.0.1 =\nFixed a bug where WP_PluginBase is properly included and defined. This is the 2nd. version of WP Shortcode Shield.\n\n= 1.0 =\n* This is the first version of WP Shortcode Shield.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvicchi%2Fwp-shortcode-shield","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvicchi%2Fwp-shortcode-shield","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvicchi%2Fwp-shortcode-shield/lists"}