PluginProbe
HTML Forms – Simple WordPress Forms Plugin / trunk
HTML Forms – Simple WordPress Forms Plugin vtrunk
trunk 1.0 1.0.1 1.0.2 1.0.3 1.0.4 1.0.5 1.0.6 1.1 1.1.1 1.1.2 1.1.3 1.1.4 1.1.5 1.2.0 1.3.0 1.3.1 1.3.10 1.3.11 1.3.12 1.3.13 1.3.14 1.3.15 1.3.16 1.3.17 All 66 releases
html-forms / readme.txt

readme.txt in HTML Forms – Simple WordPress Forms Plugin trunk, at readme.txt

676 lines 22.2 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === HTML Forms - Simple WordPress Forms Plugin ===
2 Contributors: linksoftware
3 Donate link: https://htmlformsplugin.com/
4 Tags: form, contact form, html form, email form, upload form
5 Author: HTML Forms
6 Author URI: https://htmlformsplugin.com/
7 Requires at least: 4.6
8 Tested up to: 7.0
9 Stable tag: 1.6.5
10 License: GPLv3 or later
11 License URI: http://www.gnu.org/licenses/gpl-3.0.html
12 Requires PHP: 5.3
13
14 A simpler, faster, and smarter WordPress forms plugin.
15
16 == Description ==
17
18 With [HTML Forms](https://htmlformsplugin.com/), you can easily add multi-purpose forms to your WordPress site.
19
20 The idea behind HTML Forms is different than most other form builder plugins: **You manage the form HTML. The plugin manages the PHP and a tiny bit of JavaScript**.
21
22 That's right. No "intuitive" drag & drop interface. We believe that dynamic form builders can be great, but they also severely limit your options. Also, they're slow and overly complicated from a technical point of view.
23
24 HTML Forms aims to be simpler, faster and smarter. It's the ideal plugin solution for developers looking for a simple way to create a contact form or other HTML form.
25
26 You define your form fields in HTML and the plugin takes care of submitting the form, saving the data and running a configurable set of form actions.
27
28 > ### 1. Define your form fields
29 > You can use anything that is valid HTML. Just ensure all `input` elements in your form have a `name` attribute to save the data entered in that field.
30 > ### 2. Configure your form actions
31 > By default, form submissions are automatically saved for you. You can configure several other actions to run when a form is submitted, like sending an email notification or subscribing to Mailchimp.
32 > ### 3. Show the form somewhere on your site
33 > Show your form by using the `[hf_form]` shortcode in your WordPress posts, pages or widget areas.
34
35 ## HTML Forms Features
36
37 - Full control over the HTML for the form fields. If you want, we'll help you in generating the field HTML though.
38 - Each form submission is automatically saved in your database and can be viewed in a simple table format.
39 - Configure an unlimited amount of actions to run when a form is successfully submitted. For example, sending out email notifications.
40 - Access form field values by referencing the field name, eg `[NAME]` or `[EMAIL]`.
41 - Hide form or redirect to URL after a successful submission.
42 - Configurable & translatable form messages.
43 - Field validation.
44 - Developer friendly. HTML Forms comes with a myriad of [JavaScript events](https://htmlformsplugin.com/kb/javascript-events/) and WordPress hooks that allow you to modify or extend the plugin's default behavior.
45
46 ## The Perfect WordPress Form Plugin For Everyone
47
48 HTML Forms is for everyone that wants a flexible & high performing form solution.
49
50 - Users. Managing your own site? With HTML Forms, you don't need any technical knowledge to setup a contact form.
51 - Developers. Building a site for your client? You supply the form HTML, HTML Forms takes care of validating and processing the form.
52 - Theme developers. Shipping a theme? HTML Forms allows for complete blend-in with your theme, and you don't have to write yet another contact form plugin.
53
54 With HTML Forms you can create any type of form. A contact form, email form, registration form, price quote form, you name it.
55
56 For more information, please visit [htmlformsplugin.com](https://htmlformsplugin.com/).
57
58 ## HTML Forms Premium
59
60 HTML Forms Premium is a paid add-on that extends the functionality of the free plugin. It includes:
61
62 - Submission Notifications
63 - File Uploads
64 - Webhooks
65 - Submission Export
66 - Submission Limits
67 - Require Users to Log In
68 - Data and Column Management
69 - and more...
70
71 For additional information, please visit [htmlformsplugin.com/premium](https://htmlformsplugin.com/premium).
72
73 ### Support
74
75 The [HTML Forms knowledge base](https://htmlformsplugin.com/kb/) covers a wide range of frequently asked questions.
76
77 Use the [WordPress.org plugin forums](https://wordpress.org/support/plugin/html-forms) for community support where we try to help all of our users.
78
79 ### Contributing
80
81 You can contribute to HTML Forms in various ways. For example:
82
83 - Write about the plugin on your blog or share it on social media.
84 - [Translate the plugin into your language](https://translate.wordpress.org/projects/wp-plugins/html-forms/stable/) using your WordPress.org account.
85
86 == Installation ==
87
88 1. In your WordPress admin panel, go to *Plugins > New Plugin*, search for **HTML Forms** and click "*Install now*"
89 1. Alternatively, download the plugin and upload the contents of `html-forms.zip` to your plugins directory, which usually is `/wp-content/plugins/`.
90 1. Activate the plugin
91
92 For more information, please refer to the [HTML Forms Knowledge Base](https://htmlformsplugin.com/kb/#utm_source=wp-plugin-repo&utm_medium=html-forms&utm_campaign=installation-instructions).
93
94 == Frequently Asked Questions ==
95
96 #### Where can I find help?
97 Start by going through the [HTML Forms knowledge base](https://htmlformsplugin.com/kb/#utm_source=wp-plugin-repo&utm_medium=html-forms&utm_campaign=plugin-faq) where we cover a wide range of frequently asked questions.
98
99 #### How to display a form in posts or pages?
100 Use the `[hf_form]` shortcode or the included block, in the block editor, to embed your form.
101
102 #### How to display a form in widget areas like the sidebar or footer?
103 Go to **Appearance > Widgets**, add the "Text Widget" to any of your widget areas and use the `[hf_form]` shortcode.
104
105 #### How do I show a form in a pop-up?
106
107 We recommend the [Boxzilla pop-up plugin](https://wordpress.org/plugins/boxzilla/) for this. You can use the `[hf_form]` shortcode in your pop-up box to render any of your forms.
108
109 #### Can I send an email when the form is submitted?
110
111 Yes! You can configure this by opening up the "Actions" tab when editing your form and clicking the "Email" button under "Available actions".
112
113 ### Does the plugin include anti-spam measures?
114
115 We currently recommend using [Google reCAPTCHA v3](https://htmlformsplugin.com/kb/google-recaptcha/) or the [hCaptcha plugin](https://htmlformsplugin.com/kb/hcaptcha/).
116
117
118 == Screenshots ==
119
120 1. Overview of forms in HTML Forms.
121 2. Editing form fields.
122 3. Sending an email when a form is submitted.
123 4. Viewing saved form submissions.
124 5. Hide form or redirect to URL after form submission.
125 6. Configurable form messages.
126 7. Details of a specific form submission.
127
128
129 == Changelog ==
130
131 #### 1.6.5
132 - Bug fixes.
133 - Code improvements.
134
135 #### 1.6.4
136 - Minor change to Google reCAPTCHA v3 implementation for features in HTML Forms Premium 1.7.0.
137
138 #### 1.6.3
139 - Bug fix for File Uploads field display.
140
141 #### 1.6.2
142 - Bug fix for PHP deprecation notice.
143
144 #### 1.6.1
145 - Bug fix for File Uploads field.
146
147 #### 1.6.0
148 - Added support for Google reCAPTCHA v3 as an anti-spam solution.
149 - Added an "Enable Nonce" option to the plugin's settings.
150
151 #### 1.5.6
152 - Bug fix to prevent XSS on Send Email action interface.
153
154 #### 1.5.5
155 - Minor PHP syntax cleanup and interface change.
156
157 #### 1.5.4
158 - Minor changes to the form submission process.
159 - Improved integration with the hCaptcha for WordPress plugin.
160
161 #### 1.5.3
162 - Bug fix for shortcode.
163
164 #### 1.5.2
165 - Bug fix to prevent XSS on Referrer URL data.
166 - Interface changes.
167
168 #### 1.5.1
169 - Bug fix when getting error code responses when submission data is unavailable.
170 - Bug fix for _load_textdomain_just_in_time error when plugin text is being translated.
171 - Interface changes.
172
173 #### 1.5.0
174 - New Variables for HTML Forms Submission Data (Timestamp, User Agent, IP Address, and Referrer URL).
175 - Interface changes.
176
177 #### 1.4.2
178 - Bug fix to prevent XSS on HTML Forms list table.
179
180 #### 1.4.1
181
182 - Added hooks for HTML Forms Premium features.
183 - Added Knowledge Base links throughout.
184 - Interface changes.
185
186 #### 1.4.0
187
188 - Added a "Submissions" column to the forms table.
189 - New "Wrapper Tag" setting to configure what HTML tag wraps fields in the form editor.
190 - Added "Hide Preview" option to the form editor.
191 - Improved integration with the hCaptcha for WordPress plugin.
192 - Interface changes.
193
194 #### 1.3.34 - July 7th, 2024
195
196 - Made the Submissions tab a direct link.
197 - Raw submission data is now scrollable.
198 - Added nonce verification to bulk actions on the HTML Forms list table.
199
200 #### 1.3.33 - June 24th, 2024
201
202 - Fix for adding additional choices to the Dropdown, Checkboxes, and Radio Buttons fields.
203 - Fix to prevent XSS on form Messages.
204 - Fix for the Mailchimp action's check for an email field.
205 - Interface changes.
206
207 #### 1.3.32 - June 17th, 2024
208
209 - Better handling for line breaks in field data.
210 - Fix for the "d/m/Y" date format not being handled correctly.
211
212 #### 1.3.31 - May 20, 2024
213
214 - Interface changes.
215
216 #### 1.3.30 - Mar 7, 2024
217
218 - Run form mark-up through KSES filter if user lacks `unfiltered_html` capability.
219
220 #### 1.3.29 - Feb 6, 2024
221
222 - Fix `get_field_count()` used for anti-spam protection not correctly counting fields when attribute key came directly after a line-break. Thanks [yann1cks](https://github.com/yann1cks)!
223 - Fix `data-hide-if` attribute not updating required fields correctly. Thanks [yann1cks](https://github.com/yann1cks)!
224 - Remove unused class input from Gutenberg block. Thanks [yann1cks](https://github.com/yann1cks)!
225 - Remove use of `tlite` JS dependency.
226 - Update JS dependencies.
227
228
229 #### 1.3.28 - Sep 19, 2023
230
231 - Update browserslist to support the same set of browsers as WordPress core.
232 - Delay initializing the field builder component until the DOM has fully loaded. Fixes an issue with the file upload button (from HTML Forms Premium) not appearing.
233
234
235 #### 1.3.27 - Jun 30, 2023
236
237 - Fix PHP notice for calling `WPDB::prepare` with mixed argument types.
238 - Update JS dependencies.
239
240
241 #### 1.3.26 - Nov 15, 2022
242
243 - Add pagination to submissions overview page if there are more than 500 items to show.
244 - "Move to trash" action for submissions now properly called "Delete permanently". Thanks to [Rakesh Sabale](https://github.com/ghubrakesh).
245
246
247 #### 1.3.25 - Oct 21, 2022
248
249 This release fixes a SQL injection vulnerability where users with the administrator role could execute arbitrary SQL commands.
250 Thanks to **Nguyen Duy Quoc Khanh** via [WPScan](https://wpscan.com) for the responsible disclosure.
251
252 Other changes:
253
254 - Use default WordPress collation when creating tables. Props [bengs](https://github.com/bengs).
255
256
257 #### 1.3.24 - Sep 23, 2022
258
259 - Compatibility with Swup.js, thanks to [Sam Brown](https://github.com/sam98brown)
260 - Update JavaScript dependencies.
261
262
263 #### 1.3.23 - Mar 2, 2022
264
265 - Add support for swup.js in [conditional fields](https://htmlformsplugin.com/kb/conditional-elements/) logic.
266 - Safer support for Full-Site Editing by splitting up registering and enqueueing of JS and CSS assets.
267
268
269 #### 1.3.22 - Jun 7, 2021
270
271 - Always load minified asset files, regardless of SCRIPT_DEBUG constant.
272 - Optimize JavaScript event callbacks in form editor.
273 - Fix required fields logic for when field names have multiple spaces in them.
274 - Add action parameter to AJAX endpoint for submitting forms.
275
276
277 #### 1.3.21 - May 14, 2021
278
279 - Add multisite compatibility for storing form submissions. Thanks to [Ismail Hardoum](https://github.com/elhardoum).
280 - Fix required fields logic for fields with spaces in their name.
281 - Fix replacement variables logic for fields with spaces or special characters in their name.
282 - Add nonce verification to all URL's using `_hf_admin_action`.
283
284
285 #### 1.3.20 - May 7, 2021
286
287 - Change type of referer_url column in database to `TEXT`.
288 - Pass form object to `hf_form_markup` filter hook.
289 - Refresh form editor after navigating via tabs.
290
291
292 #### 1.3.19 - Feb 16, 2021
293
294 - Add filter for file-uploads to use direct links to file instead of WP media attachment.
295 - Fix field variables not showing correctly in available tags for email action message body.
296
297
298 #### 1.3.18 - Jan 13, 2021
299
300 - Updated JS dependencies.
301 - Change plugin domain to htmlformsplugin.com.
302
303
304 #### 1.3.17 - Dec 21, 2020
305
306 - Forms are now sortable by name on overview page.
307 - Update internal dependencies to their latest versions.
308 - Add `role="alert"` to form messages.
309 - Optimize size of public JavaScript file (25% size reduction) by rewriting some dependencies.
310 - Add filter for tabs in admin area.
311
312
313 #### 1.3.16 - May 6, 2020
314
315 - Add filter hook for successful form responses: `hf_form_response`
316 - Only try to detect WPBruiser hidden input fields whenever that plugin is activated.
317 - Stop explicitly enabling shortcodes in text widgets as this is now handled by WordPress core (as of version 4.9).
318 - Explicitly set engine and charset on submissions database table.
319
320
321 #### 1.3.14 - Nov 6, 2019
322
323 **Improvements**
324
325 - Stop using `supress_filters` argument when retrieving forms, for a possible performance improvement.
326 - Prevent extra SQL query for options when global settings have not been saved yet.
327
328
329 #### 1.3.13 - Oct 18, 2019
330
331 **Fixes**
332
333 - Special HTML characters being encoded even in plain text emails.
334
335 **Improvements**
336
337 - HTML tags are no longer stripped from field values, so forms can now accept HTML. HTML is still escaped upon display to prevent XSS.
338
339
340 #### 1.3.12 - Oct 11, 2019
341
342 Compatibility with Mailchimp for WordPress 4.6.
343
344
345 #### 1.3.11 - Sep 17, 2019
346
347 **Improvements**
348
349 - Write results from Mailchimp action to MC4WP debug log.
350
351
352 #### 1.3.10 - Sep 5, 2019
353
354 **Fixes**
355
356 - PHP warning introduced in latest update when using array fields.
357
358
359 #### 1.3.9 - Sep 2, 2019
360
361 **Fixes**
362
363 - Strip out [WPBruiser](https://wordpress.org/plugins/goodbye-captcha/) token field to prevent it from being stored.
364
365 **Improvements**
366
367 - Add filter hooks to variables inside the email action. Thanks to [Ryan Salerno](https://github.com/ryansalerno).
368
369
370 #### 1.3.8 - May 28, 2019
371
372 **Fixes**
373
374 - Invalid HTML for generated textarea tag.
375
376 **Improvements**
377
378 - Improved HTML escaping, preserve double and single quotes.
379 - Explicitly set charset of HTML emails to UTF-8 by default.
380 - Escape HTML after limiting string length, not before.
381
382
383 #### 1.3.7 - April 8, 2019
384
385 **Additions**
386
387 - Add Gutenberg block for adding shortcode to content.
388 - Add setting in field builder for the `multiple` attribute on `<select>` elements.
389 - Add `hf_get_forms()` function for retrieving multiple form objects.
390
391 **Improvements**
392
393 - Add `edit_form` capability to user that activates the plugin.
394
395
396 #### 1.3.6 - March 27, 2019
397
398 **Improvements**
399
400 - Don't strip HTML from variable replacements in HTML emails. This change allows you to link to uploaded files properly.
401
402
403 #### 1.3.5 - January 29, 2019
404
405 **Improvements**
406
407 - Allow adding form field variables to the form's redirect URL.
408
409
410 #### 1.3.4 - January 9, 2019
411
412 **Improvements**
413
414 - Reload available field variables when adding action on form settings page.
415 - Add role="alert" attribute to all form messages.
416 - Emit "message" event whenever message is shown to user.
417
418
419 #### 1.3.3 - November 6, 2018
420
421 **Fixes**
422
423 - Fix selected state of email content type.
424
425 **Improvements**
426
427 - Add filter & action hook for extending forms with custom messages & message settings.
428 - Don't add line-breaks automatically when using HTML emails.
429 - Delete all related postmeta when deleting a submission.
430
431
432 #### 1.3.2 - Aug 6, 2018
433
434 **Improvements**
435
436 - Default to an empty string value in conditional fields logic. This allows you to show or hide elements when a field is empty or has not been set yet.
437
438
439 #### 1.3.1 - June 12, 2018
440
441 **Improvements**
442
443 - Format dates, files and arrays when using data variables.
444 - Format dates, files and arrays on the submissions overview and submissions details pages.
445 - Allow cancelling a form's submit event in JavaScript (with `event.stopPropagation()`) to prevent form submission.
446
447
448 #### 1.3.0 - May 28, 2018
449
450 **Fixes**
451
452 - PHP notice because of namespace import outside of any namespace.
453 - Removed usage of PHP 5.4+ feature.
454 - Enforce HTTPS in form preview iframe when WP Admin uses HTTPS but public site does not.
455
456 **Improvements**
457
458 - Hook into GDPR Personal Data Export & Erase functionality. Requires WP 4.9.6.
459 - Allow updating stored Submissions with empty values. Allows clearing out IP address & user agents.
460 - Internal field should start with underscore to hide it in column view.
461 - Add for attribute to generated label element. Allows for simple multi-step forms.
462
463 **Additions**
464
465 - Add support for button clicks in conditional element logic.
466
467
468 #### 1.2.0 - April 24, 2018
469
470 **Fixes**
471
472 - Remove use of short-array syntax, which is only available in PHP 5.4 or later.
473
474 **Improvements**
475
476 - You can now hide columns on the submissions tab using screen options (in the top right corner).
477 - You can now disable saving submissions on a per-form basis.
478 - Allow pre-checking multiple checkboxes when using the field helper
479 - Fields with matching URL parameter names will automatically be prefilled.
480 - Use SVG icon in admin menu.
481
482 **Additions**
483
484 - Add simple action for subscribing to Mailchimp. Requires the [Mailchimp for WordPress plugin](https://wordpress.org/plugins/mailchimp-for-wp/).
485
486
487 #### 1.1.5 - April 9, 2018
488
489 **Fixes**
490
491 - Conditionally hidden fields are now ignored in server-side required field validation too. Thanks [Jeroen Sormani](https://github.com/JeroenSormani)!
492
493 **Improvements**
494
495 - Added foundational stuff for being able to handle file uploads.
496
497 **Additions**
498
499 - Added `hf_process_form` action to execute code before the form actions run.
500
501
502 #### 1.1.4 - March 28, 2018
503
504 **Fixes**
505
506 - Ensure form is fully functional in live preview.
507 - Show all forms on the forms overview page (limit was 5).
508 - Parse field variables in custom email headers. Thanks [Jeroen Sormani](https://github.com/JeroenSormani)!
509
510 **Improvements**
511
512 - You can now [bind JavaScript events](https://htmlformsplugin.com/kb/javascript-events/) using the default browser API, eg `document.getElementById('hf-form-5').addEventListener('hf-success', ..);`
513 - Only load JavaScript file on pages with a form on it.
514 - Don't add line-breaks in HTML generated by the Field Builder.
515 - [Conditional elements](https://htmlformsplugin.com/kb/conditional-elements/) now accept wildcard values: `*`
516 - Available field variables in email action settings are now clickable.
517
518 **Additions**
519
520 - Added several action & filter hooks to enable advanced functionality in [HTML Forms Premium](https://htmlformsplugin.com/premium-features/).
521
522
523 #### 1.1.3 - February 12, 2018
524
525 **Fixes**
526
527 - Form preview was not working when WPML was activated.
528
529 **Improvements**
530
531 - Improved theme compatibility for the form preview.
532 - Print submission details as JSON instead of PHP object.
533 - Form messages are now added to the element as data attributes, so they can be used in JavaScript event callbacks.
534
535 **Additions**
536
537 - [Conditional logic](https://htmlformsplugin.com/kb/conditional-elements/) now accepts multiple values, separated by the |-character.
538
539
540 #### 1.1.2 - January 18, 2018
541
542 **Fixes**
543
544 - Conditional elements visible in form preview.
545 - WP_List_Table issue on forms overview page.
546
547 **Improvements**
548
549 - Allow disabling submission storage through a global setting.
550 - Hide submissions tab when submission storage is disabled.
551 - Prevent PHP notice if `$_SERVER` global is missing properties.
552 - Update JavaScript dependencies.
553
554 **Additions**
555
556 - Filter: `hf_ignored_field_names`
557
558
559 #### 1.1.1 - December 21, 2017
560
561 **Fixes**
562
563 - Incorrect role capability for administrators.
564
565
566 #### 1.1 - December 21, 2017
567
568 **Fixes**
569
570 - JavaScript error in some older browser when submitting the form.
571
572 **Improvements**
573
574 - Use custom user capability base for editing & viewing forms.
575 - Delay form response until a later hook so other plugins get a chance to hook in.
576 - Disable client-side validation for conditional fields marked as required.
577
578 **Additions**
579
580 - Added live preview to the form editor.
581
582
583 #### 1.0.6 - December 11, 2017
584
585 **Fixes**
586
587 - Array replacements in email message were showing "Array" instead of a comma separated list of values.
588 - Don't reset form when there are errors. Thanks [Jeroen Sormani](https://github.com/JeroenSormani)!
589
590 **Additions**
591
592 - You can now use certain [template variables](https://htmlformsplugin.com/kb/template-variables/) in the form content which will be dynamically replaced.
593 - Added `hf_validate_form_{$form_slug}` filter hook.
594 - Added `hf_form_{$form_slug}_success` action hook.
595
596
597 #### 1.0.5 - November 18, 2017
598
599 **Fixes**
600
601 - Could not save more than one "Email" action.
602
603
604 #### 1.0.4 - November 10, 2017
605
606 **Fixes**
607
608 - Incompatibility with PHP versions before 5.6.
609 - Data variables could not be placed on the same line.
610
611 **Improvements**
612
613 - Clear output buffer before sending AJAX response to prevent issues with response parsing.
614
615 **Additions**
616
617 - Added `hf_form_message_{$code}` filter hook.
618
619
620
621 #### 1.0.3 - November 6, 2017
622
623 **Additions**
624
625 - Added [support for conditional elements](https://htmlformsplugin.com/kb/conditional-elements/) by using `data-show-if` and `data-hide-if` attributes.
626
627 **Improvements**
628
629 - Accept `id` argument in `[hf_form]` shortcode.
630 - Catch errors in shortcode's `slug` attribute.
631 - Allow changing form slug after initial form is saved.
632
633 **Fixes**
634
635 - Fixes stylesheet URL when option to load stylesheet is toggled.
636
637
638
639 #### 1.0.2 - October 30, 2017
640
641 **Fixes**
642
643 - Form validation always failing when form has 0 required fields.
644
645 **Improvements**
646
647 - Fake success response when honeypot validation fails.
648 - Validate request by comparing size of POST array with number of form fields.
649 - Ensure submit button never has label element when using the field helper.
650 - Optimize URL generation of asset files on frontend.
651
652 **Additions**
653
654 - Added `hf_validate_form_request_size` filter hook.
655
656
657 #### 1.0.1 - October 28, 2017
658
659 **Improvements**
660 - Added SVG admin menu icon.
661 - Field names are now sanitized before they are saved in the database.
662 - Submit button was missing for default form fields.
663 - Unneeded `<form>` tags are now stripped from the form before saving.
664
665 **Additions**
666 - Added `data-title` and `data-slug` attributes to the `<form>` element on the frontend.
667
668
669 #### 1.0 - October 25, 2017
670
671 Introducing a first version of HTML Forms, a different approach to forms for WordPress sites.
672
673
674
675 == Upgrade Notice ==
676