| 1 |
=== Code Snippets === |
| 2 |
Contributors: bungeshea, ver3 |
| 3 |
Donate link: https://sheabunge.com/donate |
| 4 |
Tags: snippets, functions, code, php, multisite |
| 5 |
License: MIT |
| 6 |
License URI: license.txt |
| 7 |
Stable tag: 2.14.4 |
| 8 |
Tested up to: 5.9.3 |
| 9 |
|
| 10 |
An easy, clean and simple way to run code snippets on your site. |
| 11 |
|
| 12 |
== Description == |
| 13 |
|
| 14 |
Code Snippets is an easy, clean and simple way to run code snippets on your site. It removes the need to add custom snippets to your theme's `functions.php` file. |
| 15 |
|
| 16 |
A snippet is a small chunk of PHP code that you can use to extend the functionality of a WordPress-powered website; essentially a mini-plugin with less load on your site. |
| 17 |
Most snippet-hosting sites tell you to add snippet code to your active theme's `functions.php` file, which can get rather long and messy after a while. |
| 18 |
Code Snippets changes that by providing a GUI interface for adding snippets and **actually running them on your site** just as if they were in your theme's `functions.php` file. |
| 19 |
|
| 20 |
Code Snippets provides graphical interface, similar to the Plugins menu, for managing snippets. Snippets can be activated and deactivated, just like plugins. The snippet editor includes fields for a name, a visual editor-enabled description, tags to allow you to categorize snippets, and a full-featured code editor. Snippets can be exported for transfer to another site, either in JSON for later importing by the Code Snippets plugin, or in PHP for creating your own plugin or theme. |
| 21 |
|
| 22 |
If you have any feedback, issues, or suggestions for improvements please leave a topic in the [Support Forum](https://wordpress.org/support/plugin/code-snippets), or [join the community on Facebook](https://facebook.com/groups/codesnippetsplugin). |
| 23 |
|
| 24 |
If you like this plugin, or it is useful to you in some way, please consider reviewing it on [WordPress.org](https://wordpress.org/support/view/plugin-reviews/code-snippets). |
| 25 |
|
| 26 |
If you'd like to contribute to the plugin's code or translate it into another language, you can [fork the plugin on GitHub](https://github.com/sheabunge/code-snippets). |
| 27 |
|
| 28 |
== Translations == |
| 29 |
|
| 30 |
Code Snippets can be used in these different languages thanks to the following translators: |
| 31 |
|
| 32 |
* Belarusian – [Hrank.com](https://www.hrank.com) |
| 33 |
* Brazilian Portuguese – [Bruno Borges](http://brunoborges.info) |
| 34 |
* Chinese – [Jincheng Shan](http://shanjincheng.com) and [诗语](https://profiles.wordpress.org/f2010525/) |
| 35 |
* Chinese (Taiwan) – [Alex Lion](https://www.alexclassroom.com/) and [Chun-Chih Cheng](https://profiles.wordpress.org/alex1114/) |
| 36 |
* Croatian – [Borisa Djuraskovic from Web Hosting Hub](https://www.webhostinghub.com/) |
| 37 |
* Czech – [Lukáš Tesař](mailto:[email protected]) and [Jakub Humpolec](https://profiles.wordpress.org/jumphy/) |
| 38 |
* Danish – [Finn Sommer Jensen](https://profiles.wordpress.org/finnsommer/) |
| 39 |
* Dutch – [Sander Spies](https://github.com/sander1), [Peter Smits](https://psmits.com) and [mother.of.code.a11n](https://profiles.wordpress.org/imazed/) |
| 40 |
* English (New Zealand) and English (UK) – [webaware](https://profiles.wordpress.org/webaware/) |
| 41 |
* English (South Africa) – [webaware](https://profiles.wordpress.org/webaware/) and [Ian Barnes](https://profiles.wordpress.org/ianbarnes/) |
| 42 |
* French – [momo-fr](https://www.momofr.net/), [Didier Demory](https://www.wptrads.com/), [Cyrille Sanson](https://100son.net/) and [Shea Bunge](https://sheabunge.com) |
| 43 |
* French (Canada) – [Dominic Desbiens](https://www.dominicdesbiens.com/) |
| 44 |
* German – [Mario Siegmann](https://web-alltag.de/), [Joerg Knoerchen](https://www.sensorgrafie.de/), [David Decker](https://deckerweb.de) and [Andreas](https://profiles.wordpress.org/perryzelda/) |
| 45 |
* Greek – [Konstantinos Megas](https://profiles.wordpress.org/nextdoorpanda/) and [Toni Bishop from Jrop](https://www.jrop.com/) |
| 46 |
* Indonesian – [Jordan Silaen from ChameleonJohn.com](https://www.chameleonjohn.com/) |
| 47 |
* Italian – [Usman Wagan](https://coupontoaster.com/), [Luisa Ravelli](https://profiles.wordpress.org/darkavenger/) and [ElectricFeet](https://profiles.wordpress.org/electricfeet/) |
| 48 |
* Japanese – [mt8](https://mt8.biz/), [Takakazu Nagaya](https://profiles.wordpress.org/tanagaya/), [Naoko Takano](https://naoko.blog/) and [melvas](https://profiles.wordpress.org/melvas/) |
| 49 |
* Persian – [Mohammad Novintanon](http://mnovintan.ir/) |
| 50 |
* Russian – [Alexander Samsonov](http://www.wordpressplugins.ru/administration/code-snippets.html), [Yui](https://profiles.wordpress.org/fierevere/), [Denis Yanchevskiy](https://denisco.pro/) and [krioteh](https://profiles.wordpress.org/krioteh/) |
| 51 |
* Slovak – [Ján Fajčák](https://wp.sk) |
| 52 |
* Spanish (Colombia) and Spanish (Ecuador) – [Javier Esteban](https://javieresteban.org/) |
| 53 |
* Spanish (Spain) – [Ibidem Group](https://www.ibidemgroup.com), [Javier Esteban](https://javieresteban.org/), [Fernando Tellado](https://ayudawp.com/) and [Juanma Aranda](https://juanmaaranda.com/) |
| 54 |
* Spanish (Venezuela) – [Yordan Soares](https://yordansoar.es/) |
| 55 |
* Swedish – [Argentum](https://profiles.wordpress.org/argentum/), [Fredrik](https://profiles.wordpress.org/elbogen/) and [Tor-Bjorn Fjellner](https://profiles.wordpress.org/tobifjellner/) |
| 56 |
* Urdu – [Samuel Badree](https://mobilemall.pk/) |
| 57 |
* Vietnamese – [Tuan Phan](https://profiles.wordpress.org/khunglong/) |
| 58 |
|
| 59 |
== Installation == |
| 60 |
|
| 61 |
= Automatic installation = |
| 62 |
|
| 63 |
1. Log into your WordPress admin |
| 64 |
2. Click __Plugins__ |
| 65 |
3. Click __Add New__ |
| 66 |
4. Search for __Code Snippets__ |
| 67 |
5. Click __Install Now__ under "Code Snippets" |
| 68 |
6. Activate the plugin |
| 69 |
|
| 70 |
= Manual installation = |
| 71 |
|
| 72 |
1. Download the plugin |
| 73 |
2. Extract the contents of the zip file |
| 74 |
3. Upload the contents of the zip file to the `wp-content/plugins/` folder of your WordPress installation |
| 75 |
4. Activate the Code Snippets plugin from 'Plugins' page. |
| 76 |
|
| 77 |
Network Activating Code Snippets through the Network Dashboard will enable a special interface for running snippets across the entire network. |
| 78 |
|
| 79 |
== Frequently Asked Questions == |
| 80 |
|
| 81 |
A full list of our Frequently Asked Questions can be found at [help.codesnippets.pro](https://help.codesnippets.pro/collection/3-faq). |
| 82 |
|
| 83 |
= How do I insert snippets into the post text editor? = |
| 84 |
Code Snippets v2 is designed to be used with PHP Function Snippets, which are not intended to be inserted as content, but instead persistently on your site as if they were part of a plugin or your theme's functions.php file. |
| 85 |
|
| 86 |
Code Snippets v3 will bring a new type of snippet, Content Snippets, which are designed to be included in the content of a post or page. Stay tuned for the release! |
| 87 |
|
| 88 |
= How can I recover my site if it is crashed by a buggy snippet? = |
| 89 |
|
| 90 |
You can recover your site by enabling the Code Snippets safe mode feature. Instructions for how to turn it on are available here: <https://help.codesnippets.pro/article/12-safe-mode>. |
| 91 |
|
| 92 |
= Will I lose my snippets if I change the theme or upgrade WordPress? = |
| 93 |
No, the snippets are stored in the WordPress database, independent of the theme and unaffected by WordPress upgrades. |
| 94 |
|
| 95 |
= Can the plugin be completely uninstalled? = |
| 96 |
If you enable the 'Complete Uninstall' option on the plugin settings page, Code Snippets will clean up all of its data when deleted through the WordPress 'Plugins' menu. This includes all of the stored snippets. If you would like to preserve the snippets, ensure they are exported first. |
| 97 |
|
| 98 |
= Can I copy snippets that I have created to another WordPress site? = |
| 99 |
Yes! You can individually export a single snippet using the link below the snippet name on the 'Manage Snippets' page or bulk export multiple snippets using the 'Bulk Actions' feature. Snippets can later be imported using the 'Import Snippets' page by uploading the export file. |
| 100 |
|
| 101 |
= Can I export my snippets to PHP for a site where I'm not using the Code Snippets plugin? = |
| 102 |
Yes. Click the checkboxes next to the snippets you want to export, and then choose **Export to PHP** from the Bulk Actions menu and click Apply. The generated PHP file will contain the exported snippets' code, as well as their name and description in comments. |
| 103 |
|
| 104 |
= Can I run network-wide snippets on a multisite installation? = |
| 105 |
You can run snippets across an entire multisite network by **Network Activating** Code Snippets through the Network Dashboard. You can also activate Code Snippets just on the main site, and then individually on other sites of your choice. |
| 106 |
|
| 107 |
= Where are the snippets stored in my WordPress database? = |
| 108 |
Snippets are stored in the `wp_snippets` table in the WordPress database. The table name may differ depending on what your table prefix is set to. |
| 109 |
|
| 110 |
= Where can I go for help or suggest new features? = |
| 111 |
You can get help with Code Snippets, report bugs or errors, and suggest new features and improvements either on the [WordPress Support Forums](https://wordpress.org/support/plugin/code-snippets) or on [GitHub](https://github.com/sheabunge/code-snippets) |
| 112 |
|
| 113 |
= How can I help contribute to the development of the Code Snippets plugin? = |
| 114 |
The best way to do this is to fork the [repository on GitHub](https://github.com/sheabunge/code-snippets) and send a pull request. |
| 115 |
|
| 116 |
== Screenshots == |
| 117 |
|
| 118 |
1. Managing existing snippets |
| 119 |
2. Adding a new snippet |
| 120 |
3. Editing a snippet |
| 121 |
4. Importing snippets from an export file |
| 122 |
|
| 123 |
== Changelog == |
| 124 |
|
| 125 |
= 2.14.4 (5 May 2022) = |
| 126 |
* Fixed: Prevent array key errors when loading the snippet table with unknown order values. |
| 127 |
|
| 128 |
= 2.14.3 (10 Dec 2021) = |
| 129 |
* Fixed: Potential security issue outputting snippets-safe-mode query variable value as-is. Thanks to Krzysztof Zaj� |
| 130 |
c for reporting. |
| 131 |
|
| 132 |
= 2.14.2 (9 Sep 2021) = |
| 133 |
* Fixed: Prevent network snippets table from being created on single-site installs. |
| 134 |
* Added translations: |
| 135 |
- Spanish by [Ibidem Group](https://www.ibidemgroup.com) |
| 136 |
- Urdu by [Samuel Badree](https://mobilemall.pk/) |
| 137 |
- Greek by [Toni Bishop from Jrop](https://www.jrop.com/) |
| 138 |
* Added: Support for `:class` syntax to the code validator. |
| 139 |
* Added: PHP8 support to the code linter. |
| 140 |
* Added: Color picker feature to the code editor. |
| 141 |
* Added: Failsafe to prevent multiple versions of Code Snippets from running simultaneously. |
| 142 |
|
| 143 |
= 2.14.1 (10 Mar 2021) = |
| 144 |
* Added: Czech translation by [Lukáš Tesař](https://github.com/atomicf4ll). |
| 145 |
* Fixed: Code validator now supports `function_exists` and `class_exists` checks. |
| 146 |
* Fixed: Code validator now supports anonymous functions. |
| 147 |
* Fixed: Issue with saving the hidden columns setting. |
| 148 |
* Fixed: Replaced the outdated tag-it library with [tagger](https://github.com/jcubic/tagger) for powering the snippet tags editor. |
| 149 |
* Added: Code direction setting for RTL users. |
| 150 |
* Updated CodeMirror to version 5.59.4. |
| 151 |
* Added: Additional action hooks and search API thanks to [@Spreeuw](https://github.com/Spreeuw). |
| 152 |
|
| 153 |
= 2.14.0 (26 Jan 2020) = |
| 154 |
* Updated CodeMirror to version 5.50.2. |
| 155 |
* Added: Basic error checking for duplicate functions and classes. |
| 156 |
* Updated Italian translations to fix display issues – thanks to [Francesco Marino](https://360fun.net). |
| 157 |
* Fixed: Ordering snippets in the table by name will now be case-insensitive. |
| 158 |
* Added: Additional API options for retrieving snippets. |
| 159 |
* Fixed: Code editor will now properly highlight embedded HTML, CSS and JavaScript code. |
| 160 |
* Changed the indicator color for inactive snippets from red to grey. |
| 161 |
* Fixed a bug preventing the editor theme from being set to default. |
| 162 |
* Added: Store the time and date when each snippet was last modified. |
| 163 |
* Added: Basic error checking when activating snippets. |
| 164 |
* Fixed: Ensure that imported snippets are always inactive. |
| 165 |
* Fixed: Check the referer on the import menu to prevent CSRF attacks. Thanks to [Chloe with the Wordfence Threat Intelligence team](https://www.wordfence.com/blog/author/wfchloe/) for reporting. |
| 166 |
* Fixed: Ensure that individual snippet action links use proper verification. |
| 167 |
|
| 168 |
= 2.13.3 (13 Mar 2019) = |
| 169 |
* Added: Hover effect to activation switches. |
| 170 |
* Added: Additional save buttons above snippet editor. |
| 171 |
* Added: List save keyboard shortcuts to the help tooltip. |
| 172 |
* Added: Change "no items found" message when search filters match nothing. |
| 173 |
* Fixed: Calling deprecated code in database upgrade process. |
| 174 |
* Fixed: Include snippet priority in export files. |
| 175 |
* Fixed: Use Unix newlines in code export file. |
| 176 |
* Updated CodeMirror to version 5.44.0. |
| 177 |
* Fixed: Correctly register snippet tables with WordPress to prevent database repair errors [[#](https://wordpress.org/support/topic/database-corrupted-4/)] |
| 178 |
* Fixed: CodeMirror indentation settings being applied incorrectly |
| 179 |
|
| 180 |
= 2.13.2 (25 Jan 2019) = |
| 181 |
* Removed potentially problematic cursor position saving feature |
| 182 |
|
| 183 |
= 2.13.1 (22 Jan 2019) = |
| 184 |
* Added: Add menu buttons to settings page for compact menu |
| 185 |
* Updated: French translation updated thanks to momo-fr |
| 186 |
* Fixed: Split code editor and tag editor scripts into their own files to prevent dependency errors |
| 187 |
* Fixed: Handling of single-use shared network snippets |
| 188 |
* Fixed: Minor translation template issues |
| 189 |
* Added: Help tooltop to snippet editor for keyboard shortcuts, thanks to Michael DeWitt |
| 190 |
* Improved: Added button for executing single-use snippets to snippets table |
| 191 |
* Added: Sample snippet for ordering snippets table by name by default |
| 192 |
* Updated CodeMirror to version 5.43.0 |
| 193 |
|
| 194 |
= 2.13.0 (17 Dec 2018) = |
| 195 |
* Added: Search/replace functionality to the snippet editor. [See here for a list of keyboard shortcuts.](https://codemirror.net/demo/search.html) [[#](https://wordpress.org/support/topic/feature-request-codemirror-search-and-replace/)] |
| 196 |
* Updated CodeMirror to version 5.42.0 |
| 197 |
* Added: Option to make admin menu more compact |
| 198 |
* Fixed: Problem clearing recently active snippet list |
| 199 |
* Improved: Integration between plugin and the CodeMirror library, to prevent collisions |
| 200 |
* Improved: Added additional styles to editor settings preview |
| 201 |
* Added: PHP linter to code editor |
| 202 |
* Improved: Use external scripts instead of inline scripts |
| 203 |
* Fixed: Missing functionality for 'Auto Close Brackets' and 'Highlight Selection Matches' settings |
| 204 |
|
| 205 |
= 2.12.1 (15 Nov 2018) = |
| 206 |
* Improved: CodeMirror updated to version 5.41.0 |
| 207 |
* Improved: Attempt to create database columns that might be missing after a table upgrade |
| 208 |
* Improved: Streamlined upgrade process |
| 209 |
* Fixed: Interface layout on sites using right-to-left languages |
| 210 |
* Improved: Made search box appear at top of page on mobile [[#](https://wordpress.org/support/topic/small-modification-for-mobile-ux/)] |
| 211 |
* Updated screenshots |
| 212 |
|
| 213 |
= 2.12.0 (23 Sep 2018) = |
| 214 |
* Fixed: Prevented hidden columns setting from reverting to default |
| 215 |
* Improved: Updated import page to improve usability |
| 216 |
* Improved: Added Import button next to page title on manage page |
| 217 |
* Improved: Added coloured banner indicating whether a snippet is active when editing |
| 218 |
* Update CodeMirror to 5.40.0 |
| 219 |
|
| 220 |
= 2.11.0 (24 Jul 2018) = |
| 221 |
* Added: Ability to assign a priority to snippets, to determine the order in which they are executed |
| 222 |
* Improvement: The editor cursor position will be preserved when saving a snippet |
| 223 |
* Added: Pressing Ctrl/Cmd + S while writing a snippet will save it |
| 224 |
* Added: Shadow opening PHP tag above the code editor |
| 225 |
* Improved: Updated the message shown when there are no snippets |
| 226 |
* Added: Install sample snippets when the plugin is installed |
| 227 |
* Improved: Show all available tags when selecting the tag field |
| 228 |
* Added: Filter hook for controlling the default list table view |
| 229 |
* Added: Action for cloning snippets |
| 230 |
|
| 231 |
= 2.10.2 (21 Jul 2018) = |
| 232 |
* Added: Button to reset settings to their default values |
| 233 |
* Improved: Made uninstall cleanup optional through a plugin setting |
| 234 |
* Fixed: Applied formatting filters to snippet descriptions in the table |
| 235 |
* Improved: Ordered tags by name in the filter dropdown menu |
| 236 |
* Fixed: Incorrectly translated strings |
| 237 |
* Added: Belarusian translation by Hrank.com |
| 238 |
* Improved: Enabled sorting snippets table by tags |
| 239 |
* Updated CodeMirror to version 5.39.0 |
| 240 |
|
| 241 |
= 2.10.1 (10 Feb 2018) = |
| 242 |
* Fixed: Prevent errors when trying to export no snippets |
| 243 |
* Fixed: Use wp_json_encode() to encode export data |
| 244 |
* Fixed: Check both the file extension and MIME type of uploaded import files |
| 245 |
|
| 246 |
= 2.10.0 (18 Jan 2018) = |
| 247 |
* Improved: Added support for importing from multiple export files at once |
| 248 |
* Improved: Unbold the titles of inactive snippets for greater visual distinction |
| 249 |
* Added: New scope for single-use snippets |
| 250 |
* Improved: Don't show network snippets on subsites by default, and only to super admins |
| 251 |
* Improved: Export snippets to JSON instead of XML |
| 252 |
* Improved: More options for importing duplicate snippets |
| 253 |
* Improved: Use strings for representing scopes internally instead of numbers |
| 254 |
* Added: Allowed plugin settings to be unified on multisite through Network Settings option |
| 255 |
* Fixed: Issue with incorrectly treating network snippets as site-wide for code validation |
| 256 |
* Improved: Rename 'Export to PHP' to 'Download', and add button to edit snippet page |
| 257 |
|
| 258 |
**[The full changelog is available on GitHub](https://github.com/sheabunge/code-snippets/blob/master/CHANGELOG.md)** |
| 259 |
|
| 260 |
== Upgrade Notice == |
| 261 |
|
| 262 |
= 2.14.2 = |
| 263 |
New color picker and code validator improvements. |
| 264 |
|
| 265 |
= 2.14.0 = |
| 266 |
Security update, last modified dates, and other improvements |
| 267 |
|
| 268 |
= 2.13.1 = |
| 269 |
Fixes for single-use snippets and French translation |
| 270 |
|
| 271 |
= 2.11.0 = |
| 272 |
Snippet priorities and other small features |
| 273 |
|
| 274 |
= 2.10.0 = |
| 275 |
Improvements for multisite and new single-use snippet scope |
| 276 |
|
