PluginProbe
Snippet Shortcodes / 5.1.7
Snippet Shortcodes v5.1.7
5.2.1 5.2 5.1.8 5.1.6 5.1.7 5.1.5 trunk 1.0 1.1 1.2 1.3 1.3.1 1.4 1.5 1.5.1 1.6 1.6.1 1.7 1.7.1 1.7.2 1.7.3 1.7.4 1.8 2.0 2.0.1 All 74 releases
shortcode-variables / readme.txt

readme.txt in Snippet Shortcodes 5.1.7, at readme.txt

451 lines 22.1 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === Snippet Shortcodes ===
2 Contributors: aliakro
3 Tags: custom,shortcode,snippet,variable,library
4 Requires at least: 6.0
5 Tested up to: 7.0.1
6 Stable tag: 5.1.7
7 Requires PHP: 8.1
8 License: GPLv2 or later
9 License URI: http://www.gnu.org/licenses/gpl-2.0.html
10 Donate link: https://www.paypal.me/yeken
11
12 Create a library of custom shortcodes and reusable content, and seamlessly insert them into your posts and pages.
13
14 == Description ==
15
16 > Create a library of custom shortcodes and reusable content, and seamlessly insert them into your posts and pages for streamlined, consistent site updates. Plus, get a head start with a built-in selection of ready-made shortcodes to use out of the box.
17
18 In addition to inserting them into your content, you can also **configure them to automatically appear in your site's header and footer. Or limit their display to desktop or mobile devices only.**
19
20 Looking to reuse the same snippet of text or HTML across your website while only updating it in one spot? [Snippet Shortcodes](https://snippetshortcodes.yeken.uk/) could be exactly what you need. With this tool, you can generate a library of custom shortcodes and embed them into your WordPress content. Using the familiar WordPress editor, you can insert anything from text and HTML to JavaScript, images, or any other elements supported by your theme or plugins. The biggest benefit? You only need to create the shortcode once, and you can then deploy it site-wide, saving time and ensuring consistency.
21
22 *Quick example*
23
24 By default, you tend to create content once and then copy and paste it across your site as needed. Later, when updates are required, you have to track down every instance, edit each one individually, and save every page or post - making consistent updates a tedious process. Instead, put a snippet like this into one of our [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) and get a shortcode you can paste into your content. To update, all you need to do is edit the [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) and your entire site will update consistently.
25
26 ``<a href="https://www.facebook.com/yekenuk" target="_blank" rel="noopener">Our Facebook</a>
27
28 to
29
30 ``[sv slug="facebook-link"]
31
32 **Basic Features**
33
34 * **[Custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes)** – Create up to 10 custom shortcodes that can be embedded throughout your website.
35 * **[Parameters](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes)** – Enhance your shortcodes by passing parameters into them e.g. [ sv slug="logo" color="blue" ]
36 * **[Ready made shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/core)** – A collection of ready-made shortcodes for displaying common WordPress fields such as site title, username, admin email, etc.
37 * **HTML editor** – a HTML editor for editing your [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes).
38
39 **Premium Features**
40
41 * **Automatically insert into your site's header or footer** – auto insert your [custom shortcode's](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) content into either your site's header and/or footer.
42 * **[Limit header/footer to specific pages](https://yeken.gitbook.io/snippet-shortcodes/features/interactive-blocks/auto-insert-into-header-footer)** – restrict an auto-inserted header/footer shortcode to a chosen list of page slugs, instead of it appearing on every page.
43 * **Limit to certain device types** – specify whether your [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) should only be visible on Mobile, Tablet, Desktop or all three.
44 * **[Limit to user roles](https://yeken.gitbook.io/snippet-shortcodes/features/role-targeting)** – show a [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) only to guests or to specific WordPress user roles.
45 * **[Schedule visibility](https://yeken.gitbook.io/snippet-shortcodes/features/visibility-scheduling)** – optionally limit a [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) to a start/end date and time window.
46 * **[Render-count analytics](https://yeken.gitbook.io/snippet-shortcodes/features/render-analytics)** – see how many times each [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) has been rendered, right on the edit screen.
47 * **[Content revision history](https://yeken.gitbook.io/snippet-shortcodes/features/revision-history)** – every save is kept as a revision (last 20 per shortcode), with one-click restore.
48 * **No limits** – create unlimited [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes).
49 * **Inline editor** – Ability to edit [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) quickly using the inline editor.
50 * **Duplicator** – Ability to duplicate [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) with one button click.
51 * **Enable/Disable** – Ability to enable or disable [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes).
52 * **Multi-site** – use [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) throughout your entire multi-site, not just limited to the one child site.
53 * **[CSV import & export](https://yeken.gitbook.io/snippet-shortcodes/features/csv-import)** – Bulk import your custom shortcodes, or export your entire collection to CSV.
54 * **[WooCommerce fields](https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium/woocommerce-meta-fields)** – A ready-made shortcode to display WooCommerce fields.
55 * **[Fetch values from database](https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium/database-values-by-id)** – A ready-made shortcode to fetch a value from any database table.
56 * An enhanced [collection of ready-made shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium) for displaying additional WordPress fields, as well as wrapping around PHP functionality like GET/POST values, number of users, etc.
57
58 ==Pricing Plans==
59
60 We're very transparent on our pricing and usually offer two plans: *yearly* and *lifetime*. For further information, please visit [our upgrade page](https://shop.yeken.uk/product/shortcode-variables/).
61
62 == Getting support ==
63
64 If you have a question or an issue, please ask on the plugin's [WordPress support page](https://wordpress.org/support/plugin/shortcode-variables/), and we'll be more than happy to help.
65
66 == Useful links ==
67
68 * [Snippet Shortcodes - Premium](https://snippetshortcodes.yeken.uk/) – main website for the Premium plugin.
69 * [Snippet Shortcodes - Core](https://wordpress.org/plugins/shortcode-variables/) – WordPress.org page for the core plugin.
70 * [Technical Documentation](https://yeken.gitbook.io/snippet-shortcodes) – Installation and detailed documentation on how to use the plugin.
71 * [Trial license](https://shop.yeken.uk/get-a-trial-license/) – Get a trial license to try out all the features.
72 * [Upgrade](https://shop.yeken.uk/product/shortcode-variables/) – purchase a license to receive all of the features.
73
74 == Screenshots ==
75
76 1. [Custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) list, with inline editor, duplicate, and delete options.
77 2. Add a new [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes).
78 3. Edit an existing [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes).
79 4. Embeded the [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) into a page.
80 5. A [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) rendered on a page.
81 6. Admin page listing the [collection of ready-made shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium) available.
82 7. [CSV import](https://yeken.gitbook.io/snippet-shortcodes/features/csv-import) screen.
83
84 == Upgrade Notice ==
85
86 Version 5.1 now supports automatic insertion into your site's header or footer. Plus, you can now specify which device types your shortcode should appear on.
87
88 == Changelog ==
89
90 = 5.1.7 =
91
92 * Improvement: CSV import/export now covers every shortcode setting (header/footer insertion, per-page targeting, device type, roles, visibility scheduling), not just slug/content/global/enabled - extensible via a new "sh-cd-csv-columns" filter for the Premium plugin.
93 * Bug fix: Fixed an issue where saving an existing shortcode a second time could silently reset Premium settings such as role targeting, visibility scheduling, or per-page header/footer targeting back to their defaults.
94 * New Feature: Added a setting to disable render-count analytics, for high-traffic sites wanting to avoid the extra database write on every shortcode render (Premium).
95 * Improvement: Updated the Premium feature list shown on the shortcode edit screen and marketing pages to include recently added Premium capabilities.
96
97 = 5.1.6 =
98
99 * New Feature: Added CSV export, alongside the existing CSV import, from the "Import shortcodes" screen.
100 * Improvement: Added database columns and extension hooks (shortcode rendered, shortcode revision history) to support additional Premium features.
101 * Improvement: Added a database column to support per-page targeting of automatically-inserted header/footer shortcodes in the Premium plugin.
102
103 = 5.1.5 =
104
105 * Bug fix: Cloning a shortcode from the list screen is now protected against CSRF with a nonce.
106 * Bug fix: CSV import no longer silently accepts rows with missing content.
107 * Bug fix: Corrected an issue where the "new Premium version available" notice could keep reappearing after being dismissed.
108 * Bug fix: Corrected the cache duration used when fetching license prices.
109 * Improvement: Settings that only apply to Premium are now properly disabled, not just greyed out, until you upgrade.
110 * Improvement: Cleaned up unused code on the "Your Shortcodes" list screen.
111
112 = 5.1.4 =
113
114 * Maintenance: Updated and tested to WP version 7.0.1.
115 * Maintenance: Updated min PHP version to 8.1.
116
117 = 5.1.3 =
118
119 * Maintenance: Updated and tested to WP version 6.9.4.
120
121 = 5.1.2 =
122
123 * Improvement: Updated links to the GitBook documentation website https://yeken.gitbook.io/snippet-shortcodes
124
125 = 5.1.1 =
126
127 * New Feature: Added a new button on plugin help page to allow the plugin database tables to be checked and fixed if required.
128
129 = 5.1 =
130
131 * New Feature: Added the ability to state whether your shortcode should be displayed on mobile, desktop, tablet or all three.
132 * New Feature: Added the ability to specify whether your shortcode should automatically be injected into your header or footer.
133 * Improvement: Only show multisite options if plugin is actually installed on a multisite
134 * Bug fix: Ensured the multisite version of a shortcode is correctly deleted when the shortcode is deleted locally.
135
136 = 5.0.1 =
137
138 * Improvement: Latest version number of Premium plugin is now fetched from the release manifest rather than hardcoded into the plugin.
139 * Improvement: Only reach out to YeKen servers for update notices once a day, rather than hourly.
140 * Bug fix: Corrected issue where each page call would look for update message from Yeken.
141
142 = 5.0 =
143
144 * New feature: A new HTML Editor when adding/editing your own shortcodes.
145 * Change: Premium features have been moved to a separate plugin (in accordance with WordPress rules). Please [download and activate Snippet Shortcodes – Premium](https://snippetshortcodes.yeken.uk/download/)
146 * Change: Simplified slugs for premade shortcodes by dropping the prefix "sc-" e.g. "sc-php-get-value" is now "php-get-value".
147 * Improvement: Added "Copy to clipboard" button to the shortcode list page.
148 * Improvement: Added new plugin icon to WP Admin Menu and WP Editor.
149 * Improvement: Added tooltips to the admin interfaces (these can be disabled in settings).
150 * Improvement: Plugin JS, CSS and other assets are only loaded on Shortcode Snippet admin pages (rather than any admin page).
151 * Improvement: Updated Fontawesome library and moved from CDN to self hosted (e.g. dependencies are now included in the plugin).
152 * Improvement: Various UI tweaks.
153 * Improvement: Added various hooks.
154 * Bug fix: Fixed an issue where button "Add" button was not resetting correctly after a failed attempt to add a shortcode.
155 * Bug fix: Refreshing the shortcode list after saving a shortcode won't cause an error message to be displayed.
156
157 = 4.2.5 =
158
159 * Bug fix: In some instances, slug couldn't be specified when not a Premium user.
160
161 = 4.2.4 =
162
163 * Change: Updated Readme.txt.
164
165 = 4.2.3 =
166
167 * Improvement: All shortcodes are now editable even if there is no premium license. Previously only the top 10 shortcodes could be edited.
168 * Improvement: Display update messages from Yeken.uk in Admin notices.
169 * Change: Slugs can no longer be changed if not in Premium.
170 * Bug fix: Fixed issues where save notifications etc appeared incorrectly within title boxes.
171
172 = 4.2.2 =
173
174 * Version bump for WP 6.8 compatibility.
175
176 = 4.2 =
177
178 * New feature: Added Premium shortcode for displaying WooCommerce user fields. Read more: https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium/woocommerce-meta-fields
179 * New feature: Added Premium shortcode for displaying WordPress meta fields. Read more: https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium/wordpress-user-fields
180
181 = 4.1.7 =
182
183 * Improvement: Added additional security checks to Ajax handlers.
184
185 = 4.1.6 =
186
187 * New Feature: Extended [sv slug="sc-db-value-by-id"] shortcode to include the new argument "key-query-string". This allows a key to be read from the matching querystring value. Read more: https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium/database-values-by-id
188
189 = 4.1.5 =
190
191 * Maintenance: Added a nonce to the main admin Add/Edit UI screen. Although the form was on an admin screen and not exposed to the public, it doesn't hurt to add a nonce as well. Thanks Benedictus Jovan (aillesiM).
192
193 = 4.1.4 =
194
195 * Maintenance: Updated tested with WP 6.5 note.
196
197 = 4.1.3 =
198
199 * Bug fix: Fixed incorrect reference to ws_ls_to_bool() with sh_cd_to_bool()
200
201 = 4.1.2 =
202
203 * Improvement: By default, the shortcode [sv slug="sc-db-value-by-id"] shall be disabled unless explicitly enabled in WP Admin.
204 * Improvement: Added the setting ''"sc-db-value-by-id" shortcode enabled?' to enable the shortcode [sv slug="sc-db-value-by-id"].
205 * Improvement: Added filter "disable-ss-sc-db-value-by-id" to hard disable the shortcode [sv slug="sc-db-value-by-id"].
206
207 = 4.1.1 =
208
209 * Improvement: Dropped the database table prefix from the shortcode [sv slug="sc-db-value-by-id"] e.g. instead of specifying "users" table, it would now be "wp_users" (i.e. if a WP table, specify the prefix)
210
211 = 4.1 =
212
213 * New Feature: New Premium shortcode for fetching a value from a MySQL table, [sv slug="sc-db-value-by-id"]. Read more: https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium/database-values-by-id
214
215 = 4.0.4 =
216
217 * Bug fix: Added extra error handling around no multisite tags.
218
219 = 4.0.3 =
220
221 * Updated "Tested upto" statement.
222
223 = 4.0.2 =
224
225 * Tested up to version 6.0.
226
227 = 4.0.1 =
228
229 * Updated "Tested upto" WP version.
230
231 = 4.0 =
232
233 * New feature: Bulk import of shortcodes via CSV.
234 * New feature: Quick Add shortcodes without having to open the editor and wait for page refreshes.
235 * Improvement: Shortcodes can be deleted via Ajax on the list page. This saves waiting for a page refresh.
236 * Improvement: Added "loading" animations on relevant UI elements.
237 * Improvement: General code refactoring.
238 * Bug fix: Allowed text in JS files to be correctly localised.
239
240 = 3.5.4 =
241
242 * Updated version WP compatibility statement.
243
244 = 3.5.3 =
245
246 * Updated version WP compatibility statement.
247
248 = 3.5.2 =
249
250 * Version bump.
251
252 = 3.5.1 =
253
254 * Bug fix: Corrected documentation and GitHub issue links.
255 * Added a little text about emailing in suggestions.
256
257 = 3.5 =
258
259 * New Feature: New settings page.
260 * New Feature: Allow authors and editors to view and edit your shortcodes.
261
262 = 3.4.1 =
263
264 * Bug fix: Fixed issue with saving.
265
266 = 3.4 =
267
268 * Improvement: Cosmetic tweaks to shortcode list table.
269 * Bug fix: Fixed an issue where license price wasn't being displayed correctly.
270 * Change: Updated links to new documentation website: https://snippet-shortcodes.yeken.uk/
271 * Change: Free users are now limited to 15 shortcodes.
272 * Change: Tweaked Upgrade URL and default price.
273
274 = 3.3.3 =
275
276 * Updated "Tested upto" statement within readme.txt.
277
278 = 3.3.2 =
279
280 * Renamed plugin to Snippet Shortcodes!
281
282 = 3.3.1 =
283
284 * Updated tested upto version for 5.6
285
286 = 3.3 =
287
288 * Improvement: Removed "Your shortcode has been saved" confirmation page.
289
290 = 3.2.1 =
291
292 * Readme tweaks.
293
294 = 3.2 =
295
296 * New Shortcode: "sc-user-profile-photo" – display the current user's profile photo.
297
298 = 3.1.1 =
299
300 * Updated compatibility version number.
301
302 = 3.1 =
303
304 * New Shortcode: "sc-site-current-url" – get the current URL.
305 * New Shortcode: "sc-site-register-url" – get the URL for the WordPress registration page.
306 * Improvement: Added localised strings so plugin can now be translated.
307 * Improvement: Licenses are now checked daily and on each upgrade to ensure they are still valid.
308 * Bug fix: Missing array element throwing error on shortcode listing page.
309 * Bug fix: PHP warning being thrown on license page when one hasn't been added.
310 * Bug fix: Always create multisite database table regardless.
311
312 = 3.0.4 =
313
314 * Improvement: Fetch license price from YeKen API
315
316 = 3.0.3 =
317
318 * Bug fix: Removed debug data altogether as causing unintended behaviour.
319
320 = 3.0.2 =
321
322 * Bug fix: Only display HTML caching comment on pages / posts. Currently rendering on things like AJAX responses and causing unintended behaviour.
323
324 = 3.0.1 =
325
326 * Bug fix: Fix error being thrown when not a multi site and DB table missing.
327
328 = 3.0 =
329
330 * Improvement: Support for multi-site variables.
331 * Improvement: Replace shortcodes within menu titles.
332
333 = 2.4.1 =
334
335 * Bug fix: fixed save_result undeclared variable error.
336
337 = 2.4 =
338
339 * New Feature: Added a button to the WordPress text editor (classic mode) to allow users to easily insert shortcodes.
340 * New Fetaure: Added a new shortcode sc-date. Allows you to do render today's date and add or subtract days, months and years.
341
342 = 2.3 =
343
344 * Improvement: sc-user-counts – Display a count of all WordPress users or the number of WordPress users for a given role e.g. [sv slug="sc-user-counts" role="subscriber"] or [sv slug="sc-user-counts"].
345
346 = 2.2.1 =
347
348 * Bug fix: Fixed issue with clone.
349
350 = 2.2 =
351
352 * Improvement: Slugs can now be edited.
353
354 = 2.1 =
355
356 * New Feature: Added the ability to clone your own shortcodes.
357
358 = 2.0.1 =
359
360 * Bug fix: Fixed broken menu
361
362 = 2.0 =
363
364 * New Feature: Added additional premium shortcodes.
365 * New Feature: Inline editing of shortcodes from the main list screen.
366 * New Feature: Able to disable / enable shortcodes from shortcode list.
367 * Improvement: Refactoring and optimisation of the entire plugin code.
368 * Improvement: Added Fooicons.
369 * Improvement: Added simple form validation when adding a record.
370
371 = 1.8 =
372
373 * Improvement: Added escaping for premade shortcodes.
374 * Improvement: Added new shortcode "sc-privacy-url" for rendering Privacy URL link.
375
376 = 1.7.4 =
377
378 – Version and readme.txt updated to reflect 4.8 compatibility.
379
380 = 1.7.3 =
381
382 – BUG FIX: On the very first load of a variable it would return nothing. This was due to a bug in the code. The first load would display nothing to the user, however it would cache the shortcode correctly. Upon the next visit, the shortcode would render correctly!
383
384 = 1.7.2 =
385
386 – When creating a new shortcode, "Disabled" is set by default to "No".
387 – Additional upgrade check added. This compares the previously stored version number against the new version number. If there is a difference, it will run the DB table check again.
388
389 = 1.7.1 =
390
391 – BUG FIX: Tweak made to "on activate" so the code required to change the relevant database tables is called correctly.
392
393 = 1.7 =
394
395 – Disable a variable. You can now disable a variable via the admin panel – if a shortcode is disabled nothing will be rendered in it's place (will remove the shortcode though).
396
397 = 1.6.1 =
398
399 – BUG FIX: Array declaration caused 500 error on non PHP 7
400
401 = 1.6 =
402
403 – Now supports custom parameters. You can now add parameters when inserting a shortcode and specify where in the shortcode those parameters should appear.
404 – BUG FIX: Removed a stray var_dump()
405
406 = 1.5.1 =
407
408 * BUG FIX: "Add new" link for message "You haven't created any shortcodes yet." wasn't working correctly
409 * BUG FIX: Typo – "Shotcodes" instead of "Shortcodes" on "Your Shortcodes" page
410
411 = 1.5 =
412
413 * Added a shorter shortcode slug. So, instead of [shortcode-variables slug="your-slug-name"] you can also use [s-var slug="your-slug-name"]
414 * BUG FIX: Some pre-made shortcodes weren't being rendered in the correct place. Fixed.
415
416 = 1.4 =
417 * Added the new pre-made shortcodes:
418 * sc-login-page – Wordpress login page. Add the parameter "redirect" to specify where the user is taken after a successful login e.g. redirect="http://www.google.co.uk".
419 * sc-username – Display the logged in username.
420 * sc-user-id – Display the current user's ID
421 * sc-user-ip – Display the current user's IP address.
422 * sc-user-email – Display the current user's email address.
423 * sc-username – Display the current user's username.
424 * sc-first-name – Display the current user's first name.
425 * sc-last-name – Display the current user's last name.
426 * sc-display-name – Display the current user's display name.
427 * sc-user-agent – Display the current user's user agent
428 * BUG FIX: Deleting a shortcode from cache when deleted from Admin panel. This stops it getting rendered when removed from the plugin.
429
430 = 1.3.1 =
431
432 * Added some messages to encourage people to suggest premade tags.
433 * Added version numbers. These are stored in DB to aid future upgrades.
434
435 = 1.3 =
436
437 This was a dummy release to fix an SVN issue with the 1.2 release!
438
439 = 1.2 =
440
441 * Added Premade shortcodes and framework to add additional ones
442 * Added Top Level menu item to support two sub pages. One for user defined shortcodes and another for premade shortcodes.
443
444 = 1.1 =
445 * Added caching to SQL queries. Therefore making shortcode rendering faster and reduce load on mySQL.
446 * TinyMCE editor for editing shortcode content.
447 * You can now specify other shortcodes within your Snippet Shortcodes.
448 * Readme.txt fixes
449
450 = 1.0 =
451 * Initial Release