Project Home Page<\/a> for more information. This plugin requires PHP 5.2.6 or greater.<\/p>\n\nThis plugin can save you from writing lots of other plugins because you can easily tie into PHP files without having to register your own plugins.<\/p>\n\n
WARNING: this has not been tested on Windows servers. Sorry, but I don't have access to one, so I've been unable to tune the permissions checks.<\/p>\n\n
Create PHP Snippets<\/h3>\n\n
A PHP snippet is any bit of code that you wish to reuse via shortcode. Create a file in one of the directories you defined as a Snippet directory. DO NOT<\/em> create Snippets inside the wp-content\/plugins\/php-snippets\/<\/code> directory!<\/p>\n\nIn order to be picked up on the radar, your file must use one of the extensions you defined (e.g. .snippet.php<\/code>) and you should include a comment block with a \"Description\" and a \"Shortcode\" attribute, e.g.<\/p>\n\n\/*\nDescription: Generates a link to a post or page based on its ID.\nShortcode: [link id=123]Click here[\/link]\n*\/<h3>Usage<\/h3>\n<\/code><\/pre>\n\n1. Create a new post or page\n1. Click the <?php<\/code> button in the TinyMCE toolbar to see a list of available PHP Snippets\n1. Select the Snippet you want to insert into your post: a shortcode should be generated inside your post content.<\/p>\n\nOptionally, you can manually type in the shortcode and add in any variables you have defined.<\/p>\n\n
Widget<\/h3>\n\n
You can add your snippet output to any Widget by using the PHP Widget.<\/p>\n\n
\n- In the WP dashboard, navigate to Appearance --> Widgets<\/li>\n
- Drag the PHP Widget from the list of available widgets to any valid widget area on the right.<\/li>\n
- Add a title for your widget<\/li>\n
- Select one of your PHP Snippets<\/li>\n
- Adjust the shortcode as desired (e.g. to add in special parameters)<\/li>\n
- Save the widget instance.<\/li>\n<\/ol>\n\n\n
You can install this plugin in the standard way from the WordPress plugin admin screen, or you can download its files and upload the php-snippets<\/code> folder to the \/wp-content\/plugins\/<\/code> directory.<\/p>\n\n\n- Upload the
php-snippets<\/code> directory to the \/wp-content\/plugins\/<\/code> directory<\/li>\n- Define one or more Snippet directories where you will save your custom PHP Snippets, e.g. [+ABSPATH+]\/snippets\/<\/li>\n<\/ol>\n\n\n
\n- My Snippets are not showing up!<\/dt>\n
Make sure your files use the correct extension. If you have configured the plugin to look for .snippet.php<\/code> files, then any .php<\/code> files will not be selectable as PHP Snippets.<\/p>\n\nMake sure you have correctly configured your PHP Snippets directory under Settings --> PHP Snippets<\/em>. The directory has to be a full<\/em> path, e.g. \/home\/myuser\/public_html\/snippets<\/code> or you can use the [+ABSPATH+]<\/code> placeholder to point to the web root of your site, e.g. [+ABSPATH+]mysnippets<\/code><\/p><\/dd>\n- What information needs to be in the Snippet header?<\/dt>\n
As of version 0.9, the information header is optional. Using it, however, can enhance the user experience because it lets users know what your Snippet does and you can customize the inputs.<\/p>\n\n
Your Snippets should include an information header in the same way that WordPress plugins and themes, but it's simplified. Include a Description:<\/em> and a Shortcode:<\/em> to indicate a description and a sample shortcode, respectively.<\/p>\n\n\/*\nDescription: Generates a link to a post or page based on its ID.\nShortcode: [link id=123]Click here[\/link]\n*\/\n<\/code><\/pre>\n\nLook at the examples in the php-snippets\/snippets<\/code> directory for some examples.<\/p><\/dd>\n- What inputs does my Snippet accept?<\/dt>\n
Anything you pass in your shortcode will be passed to your Snippet. E.g. [mySnippet x=\"123\" y=\"Llama\"]<\/code> will make the variables $x<\/code> and $y<\/code> available in your Snippet (they would contain \"123\" and \"Llama\", respectively).<\/p>\n\nThe $content<\/code> variable is reserved for when you use a full<\/em> tag, e.g. [mySnippet]My content goes here[\/mySnippet] would make<\/code>$content` contain the text \"My content goes here\".<\/p>\n\nWarning: WordPress allows only<\/em> lowercase parameter names, so your input variables should be lowercase.<\/p><\/dd>\n- What should my Snippet output?<\/dt>\n
Your Snippet should print<\/em> its output (not return<\/em> it). This makes it easy for you to include reusable bits of HTML.<\/p>\n\nTechnically speaking, your code doesn't have<\/em> to output anything -- some scripts may only need to execute on the back-end and remain out of site.<\/p><\/dd>\n- There's a Bug in the Plugin!<\/dt>\n
Check to make sure the bug is actually in the plugin and not in one of your Snippets. This plugin attempts to act primarily as a transparent pass-through, and the error messages should be confined to your<\/em> code (hopefully not mine). The plugin is no longer maintained, so if there is a bug in the code, you'll have to find a way to fix it yourself.<\/p><\/dd>\n\n<\/dl>\n\n\n1.2<\/h4>\n\n
Retirement notice. Thank you to everyone who contributed to this plugin, but it is now officially retired. Licensing is disabled with this version.<\/p>\n\n
1.1<\/h4>\n\n
Includes handy features:<\/p>\n\n
\n- Ability to show\/hide the TinyMCE button<\/li>\n
- \"PHP Snippets\" button now visible in plain-text view<\/li>\n<\/ul>\n\n
1.0<\/h4>\n\n\n- PHP 5.3.0 is now required.<\/li>\n
- Configurable suffix, so now your snippets need not use the '.snippet.php' extension.<\/li>\n
- Pay-what-you-like licensing added. <\/li>\n
- Various bug fixes and improvements<\/li>\n<\/ul>\n\n
0.8<\/h4>\n\n\n- Improved permissions checking in Windows environments.<\/li>\n
- General cleanup.<\/li>\n<\/ul>\n\n
0.7<\/h4>\n\n
More thorough permissions checking of the configured directories, added some snippets.<\/p>\n\n
0.6<\/h4>\n\n
Worked out some bugs, cleaned this thing up for the prom.<\/p>\n\n
0.5<\/h4>\n\n\n- Initial release<\/li>\n<\/ul>","raw_excerpt":"Provides an interface for developers to easily add PHP code to posts and widgets via selectable shortcodes.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/15498","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=15498"}],"author":[{"embeddable":true,"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/fireproofsocks"}],"wp:attachment":[{"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=15498"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=15498"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=15498"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=15498"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=15498"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/ar.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=15498"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}