PluginProbe
Snippet Shortcodes / 5.1.5
Snippet Shortcodes v5.1.5
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.5, at readme.txt

433 lines 19.7 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.5
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 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.
43 * **No limits** – create unlimited [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes).
44 * **Inline editor** – Ability to edit [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) quickly using the inline editor.
45 * **Duplicator** – Ability to duplicate [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) with one button click.
46 * **Enable/Disable** – Ability to enable or disable [custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes).
47 * **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.
48 * **[CSV import](https://yeken.gitbook.io/snippet-shortcodes/features/csv-import)** – Bulk import your custom shortcodes.
49 * **[WooCommerce fields](https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium/woocommerce-meta-fields)** – A ready-made shortcode to display WooCommerce fields.
50 * **[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.
51 * 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.
52
53 ==Pricing Plans==
54
55 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/).
56
57 == Getting support ==
58
59 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.
60
61 == Useful links ==
62
63 * [Snippet Shortcodes - Premium](https://snippetshortcodes.yeken.uk/) – main website for the Premium plugin.
64 * [Snippet Shortcodes - Core](https://wordpress.org/plugins/shortcode-variables/) – WordPress.org page for the core plugin.
65 * [Technical Documentation](https://yeken.gitbook.io/snippet-shortcodes) – Installation and detailed documentation on how to use the plugin.
66 * [Trial license](https://shop.yeken.uk/get-a-trial-license/) – Get a trial license to try out all the features.
67 * [Upgrade](https://shop.yeken.uk/product/shortcode-variables/) – purchase a license to receive all of the features.
68
69 == Screenshots ==
70
71 1. [Custom shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) list, with inline editor, duplicate, and delete options.
72 2. Add a new [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes).
73 3. Edit an existing [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes).
74 4. Embeded the [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) into a page.
75 5. A [custom shortcode](https://yeken.gitbook.io/snippet-shortcodes/features/own-shortcodes) rendered on a page.
76 6. Admin page listing the [collection of ready-made shortcodes](https://yeken.gitbook.io/snippet-shortcodes/features/ready-made/premium) available.
77 7. [CSV import](https://yeken.gitbook.io/snippet-shortcodes/features/csv-import) screen.
78
79 == Upgrade Notice ==
80
81 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.
82
83 == Changelog ==
84
85 = 5.1.5 =
86
87 * Bug fix: Cloning a shortcode from the list screen is now protected against CSRF with a nonce.
88 * Bug fix: CSV import no longer silently accepts rows with missing content.
89 * Bug fix: Corrected an issue where the "new Premium version available" notice could keep reappearing after being dismissed.
90 * Bug fix: Corrected the cache duration used when fetching license prices.
91 * Improvement: Settings that only apply to Premium are now properly disabled, not just greyed out, until you upgrade.
92 * Improvement: Cleaned up unused code on the "Your Shortcodes" list screen.
93
94 = 5.1.4 =
95
96 * Maintenance: Updated and tested to WP version 7.0.1.
97 * Maintenance: Updated min PHP version to 8.1.
98
99 = 5.1.3 =
100
101 * Maintenance: Updated and tested to WP version 6.9.4.
102
103 = 5.1.2 =
104
105 * Improvement: Updated links to the GitBook documentation website https://yeken.gitbook.io/snippet-shortcodes
106
107 = 5.1.1 =
108
109 * New Feature: Added a new button on plugin help page to allow the plugin database tables to be checked and fixed if required.
110
111 = 5.1 =
112
113 * New Feature: Added the ability to state whether your shortcode should be displayed on mobile, desktop, tablet or all three.
114 * New Feature: Added the ability to specify whether your shortcode should automatically be injected into your header or footer.
115 * Improvement: Only show multisite options if plugin is actually installed on a multisite
116 * Bug fix: Ensured the multisite version of a shortcode is correctly deleted when the shortcode is deleted locally.
117
118 = 5.0.1 =
119
120 * Improvement: Latest version number of Premium plugin is now fetched from the release manifest rather than hardcoded into the plugin.
121 * Improvement: Only reach out to YeKen servers for update notices once a day, rather than hourly.
122 * Bug fix: Corrected issue where each page call would look for update message from Yeken.
123
124 = 5.0 =
125
126 * New feature: A new HTML Editor when adding/editing your own shortcodes.
127 * 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/)
128 * Change: Simplified slugs for premade shortcodes by dropping the prefix "sc-" e.g. "sc-php-get-value" is now "php-get-value".
129 * Improvement: Added "Copy to clipboard" button to the shortcode list page.
130 * Improvement: Added new plugin icon to WP Admin Menu and WP Editor.
131 * Improvement: Added tooltips to the admin interfaces (these can be disabled in settings).
132 * Improvement: Plugin JS, CSS and other assets are only loaded on Shortcode Snippet admin pages (rather than any admin page).
133 * Improvement: Updated Fontawesome library and moved from CDN to self hosted (e.g. dependencies are now included in the plugin).
134 * Improvement: Various UI tweaks.
135 * Improvement: Added various hooks.
136 * Bug fix: Fixed an issue where button "Add" button was not resetting correctly after a failed attempt to add a shortcode.
137 * Bug fix: Refreshing the shortcode list after saving a shortcode won't cause an error message to be displayed.
138
139 = 4.2.5 =
140
141 * Bug fix: In some instances, slug couldn't be specified when not a Premium user.
142
143 = 4.2.4 =
144
145 * Change: Updated Readme.txt.
146
147 = 4.2.3 =
148
149 * Improvement: All shortcodes are now editable even if there is no premium license. Previously only the top 10 shortcodes could be edited.
150 * Improvement: Display update messages from Yeken.uk in Admin notices.
151 * Change: Slugs can no longer be changed if not in Premium.
152 * Bug fix: Fixed issues where save notifications etc appeared incorrectly within title boxes.
153
154 = 4.2.2 =
155
156 * Version bump for WP 6.8 compatibility.
157
158 = 4.2 =
159
160 * 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
161 * 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
162
163 = 4.1.7 =
164
165 * Improvement: Added additional security checks to Ajax handlers.
166
167 = 4.1.6 =
168
169 * 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
170
171 = 4.1.5 =
172
173 * 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).
174
175 = 4.1.4 =
176
177 * Maintenance: Updated tested with WP 6.5 note.
178
179 = 4.1.3 =
180
181 * Bug fix: Fixed incorrect reference to ws_ls_to_bool() with sh_cd_to_bool()
182
183 = 4.1.2 =
184
185 * Improvement: By default, the shortcode [sv slug="sc-db-value-by-id"] shall be disabled unless explicitly enabled in WP Admin.
186 * Improvement: Added the setting ''"sc-db-value-by-id" shortcode enabled?' to enable the shortcode [sv slug="sc-db-value-by-id"].
187 * Improvement: Added filter "disable-ss-sc-db-value-by-id" to hard disable the shortcode [sv slug="sc-db-value-by-id"].
188
189 = 4.1.1 =
190
191 * 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)
192
193 = 4.1 =
194
195 * 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
196
197 = 4.0.4 =
198
199 * Bug fix: Added extra error handling around no multisite tags.
200
201 = 4.0.3 =
202
203 * Updated "Tested upto" statement.
204
205 = 4.0.2 =
206
207 * Tested up to version 6.0.
208
209 = 4.0.1 =
210
211 * Updated "Tested upto" WP version.
212
213 = 4.0 =
214
215 * New feature: Bulk import of shortcodes via CSV.
216 * New feature: Quick Add shortcodes without having to open the editor and wait for page refreshes.
217 * Improvement: Shortcodes can be deleted via Ajax on the list page. This saves waiting for a page refresh.
218 * Improvement: Added "loading" animations on relevant UI elements.
219 * Improvement: General code refactoring.
220 * Bug fix: Allowed text in JS files to be correctly localised.
221
222 = 3.5.4 =
223
224 * Updated version WP compatibility statement.
225
226 = 3.5.3 =
227
228 * Updated version WP compatibility statement.
229
230 = 3.5.2 =
231
232 * Version bump.
233
234 = 3.5.1 =
235
236 * Bug fix: Corrected documentation and GitHub issue links.
237 * Added a little text about emailing in suggestions.
238
239 = 3.5 =
240
241 * New Feature: New settings page.
242 * New Feature: Allow authors and editors to view and edit your shortcodes.
243
244 = 3.4.1 =
245
246 * Bug fix: Fixed issue with saving.
247
248 = 3.4 =
249
250 * Improvement: Cosmetic tweaks to shortcode list table.
251 * Bug fix: Fixed an issue where license price wasn't being displayed correctly.
252 * Change: Updated links to new documentation website: https://snippet-shortcodes.yeken.uk/
253 * Change: Free users are now limited to 15 shortcodes.
254 * Change: Tweaked Upgrade URL and default price.
255
256 = 3.3.3 =
257
258 * Updated "Tested upto" statement within readme.txt.
259
260 = 3.3.2 =
261
262 * Renamed plugin to Snippet Shortcodes!
263
264 = 3.3.1 =
265
266 * Updated tested upto version for 5.6
267
268 = 3.3 =
269
270 * Improvement: Removed "Your shortcode has been saved" confirmation page.
271
272 = 3.2.1 =
273
274 * Readme tweaks.
275
276 = 3.2 =
277
278 * New Shortcode: "sc-user-profile-photo" – display the current user's profile photo.
279
280 = 3.1.1 =
281
282 * Updated compatibility version number.
283
284 = 3.1 =
285
286 * New Shortcode: "sc-site-current-url" – get the current URL.
287 * New Shortcode: "sc-site-register-url" – get the URL for the WordPress registration page.
288 * Improvement: Added localised strings so plugin can now be translated.
289 * Improvement: Licenses are now checked daily and on each upgrade to ensure they are still valid.
290 * Bug fix: Missing array element throwing error on shortcode listing page.
291 * Bug fix: PHP warning being thrown on license page when one hasn't been added.
292 * Bug fix: Always create multisite database table regardless.
293
294 = 3.0.4 =
295
296 * Improvement: Fetch license price from YeKen API
297
298 = 3.0.3 =
299
300 * Bug fix: Removed debug data altogether as causing unintended behaviour.
301
302 = 3.0.2 =
303
304 * Bug fix: Only display HTML caching comment on pages / posts. Currently rendering on things like AJAX responses and causing unintended behaviour.
305
306 = 3.0.1 =
307
308 * Bug fix: Fix error being thrown when not a multi site and DB table missing.
309
310 = 3.0 =
311
312 * Improvement: Support for multi-site variables.
313 * Improvement: Replace shortcodes within menu titles.
314
315 = 2.4.1 =
316
317 * Bug fix: fixed save_result undeclared variable error.
318
319 = 2.4 =
320
321 * New Feature: Added a button to the WordPress text editor (classic mode) to allow users to easily insert shortcodes.
322 * New Fetaure: Added a new shortcode sc-date. Allows you to do render today's date and add or subtract days, months and years.
323
324 = 2.3 =
325
326 * 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"].
327
328 = 2.2.1 =
329
330 * Bug fix: Fixed issue with clone.
331
332 = 2.2 =
333
334 * Improvement: Slugs can now be edited.
335
336 = 2.1 =
337
338 * New Feature: Added the ability to clone your own shortcodes.
339
340 = 2.0.1 =
341
342 * Bug fix: Fixed broken menu
343
344 = 2.0 =
345
346 * New Feature: Added additional premium shortcodes.
347 * New Feature: Inline editing of shortcodes from the main list screen.
348 * New Feature: Able to disable / enable shortcodes from shortcode list.
349 * Improvement: Refactoring and optimisation of the entire plugin code.
350 * Improvement: Added Fooicons.
351 * Improvement: Added simple form validation when adding a record.
352
353 = 1.8 =
354
355 * Improvement: Added escaping for premade shortcodes.
356 * Improvement: Added new shortcode "sc-privacy-url" for rendering Privacy URL link.
357
358 = 1.7.4 =
359
360 – Version and readme.txt updated to reflect 4.8 compatibility.
361
362 = 1.7.3 =
363
364 – 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!
365
366 = 1.7.2 =
367
368 – When creating a new shortcode, "Disabled" is set by default to "No".
369 – 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.
370
371 = 1.7.1 =
372
373 – BUG FIX: Tweak made to "on activate" so the code required to change the relevant database tables is called correctly.
374
375 = 1.7 =
376
377 – 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).
378
379 = 1.6.1 =
380
381 – BUG FIX: Array declaration caused 500 error on non PHP 7
382
383 = 1.6 =
384
385 – Now supports custom parameters. You can now add parameters when inserting a shortcode and specify where in the shortcode those parameters should appear.
386 – BUG FIX: Removed a stray var_dump()
387
388 = 1.5.1 =
389
390 * BUG FIX: "Add new" link for message "You haven't created any shortcodes yet." wasn't working correctly
391 * BUG FIX: Typo – "Shotcodes" instead of "Shortcodes" on "Your Shortcodes" page
392
393 = 1.5 =
394
395 * Added a shorter shortcode slug. So, instead of [shortcode-variables slug="your-slug-name"] you can also use [s-var slug="your-slug-name"]
396 * BUG FIX: Some pre-made shortcodes weren't being rendered in the correct place. Fixed.
397
398 = 1.4 =
399 * Added the new pre-made shortcodes:
400 * 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".
401 * sc-username – Display the logged in username.
402 * sc-user-id – Display the current user's ID
403 * sc-user-ip – Display the current user's IP address.
404 * sc-user-email – Display the current user's email address.
405 * sc-username – Display the current user's username.
406 * sc-first-name – Display the current user's first name.
407 * sc-last-name – Display the current user's last name.
408 * sc-display-name – Display the current user's display name.
409 * sc-user-agent – Display the current user's user agent
410 * BUG FIX: Deleting a shortcode from cache when deleted from Admin panel. This stops it getting rendered when removed from the plugin.
411
412 = 1.3.1 =
413
414 * Added some messages to encourage people to suggest premade tags.
415 * Added version numbers. These are stored in DB to aid future upgrades.
416
417 = 1.3 =
418
419 This was a dummy release to fix an SVN issue with the 1.2 release!
420
421 = 1.2 =
422
423 * Added Premade shortcodes and framework to add additional ones
424 * Added Top Level menu item to support two sub pages. One for user defined shortcodes and another for premade shortcodes.
425
426 = 1.1 =
427 * Added caching to SQL queries. Therefore making shortcode rendering faster and reduce load on mySQL.
428 * TinyMCE editor for editing shortcode content.
429 * You can now specify other shortcodes within your Snippet Shortcodes.
430 * Readme.txt fixes
431
432 = 1.0 =
433 * Initial Release