Jump to content

Module: FormHelper


Recommended Posts


The redesigned FormHelper extends the InputfieldForm object with additional features. 


The FormHelper module extends the PW form object and simplifies the form handling.

  • create basic PW form object with submit button
  • add form field value handling and sanitizing
  • take care about form submit / error state and processing
  • CKEditor pwImagePlugin field, jsConfig, load form admin styles

FormHelperExtra is a submodule to handle additional features.

  • create a form object with fields based on Template, Page, Form objects or field data array
  • form file upload handling (temp page uploads, creation of a hidden storage page)




ToDo / Issues

Edited by pwFoo
  • Like 9
Link to comment
Share on other sites

Module updated to 0.0.5

Changed formProcess return values. Example at initial post is updated.

if ($process === NULL) {
     // form not sent
elseif ($process == true) {
     // form sent... without or also with errors! Check with "$fh->form->getErrors()"    
elseif ($process && $fh->form->getErrors()) {
     // form sent, but with errors!
elseif ($process && !$fh->form->getErrors()) {
    // form sent without errors! 
    // Do something...    

Because I need to return TRUE if form is sent without and also with errors...

Link to comment
Share on other sites

Module need some improvements to work with inputtype (ckeditor, tinymce) and textformatters (TextformatterTextile, ...).

In a earlier version it loads ckeditor or tinymce. But not tested with textformatters which need to load the textformatter module and call formatValue() method I think...

Link to comment
Share on other sites

To handle textformatter I'll add an option to get the fields or some fields unformatted if needed (maybe difficult to decide...).

At the moment I use $pageObj->getInputfields() to get all fields. Maybe should be changed to a loop through all fields to get it formatted or unformatted

// unformatted, for example to get textile source for edit instead of parsed html code
// or formatted

Haven't found an way to "convert" a formatted field to an unformatted.

Link to comment
Share on other sites

You can't convert a formatted field to a unformatted. 

$page->of(false)  // turn off outputformatting
$page->body // unformatted
$page->of(true) // turn outputformatting on
$page->body // formatted

or directly as you already have

Link to comment
Share on other sites

Updated version with improved clearValues and added unformattedFields (true = all || array with field names) option.

The unformattedFields option is needed by FrontendContentManager for editing pages with textformatter active fields (for example TextformatterTextile).

Link to comment
Share on other sites

New FormHelper dev branch 0.0.7

  • removed hardcoded allowed file extensions (forgotten test string...)
  • changed jsconfig handling (now js-code is prepended to $config->scripts

I thinking about a honeypot feature to make forms (more) "secure" against bots...

What do you think? Would it be a good idea?

  • Like 1
Link to comment
Share on other sites

This looks promising. So basically this will allow us to easily create front-end forms for editing content, posting content etc? I'm looking for something that will allow me to use my own markup on the front-end for my members to use.

Honeypot seems a good idea as an option as Ryan suggests with his comments field.

Will this work with a Fancybox modal window? I'd like to be able to click on an edit button on a front-end page, have a form pop up via something like Fancybox or Foundation and then for it to process the form and redirect to a page of my choice etc.

Link to comment
Share on other sites

FormHelper care about form handling (build form, process input, upload files,...).

FrontendContendManaget (FCM) requires FormHelper to create a form based on an existing page or template and provide update / save methode.

My login and register modules also based on FormHelper and create the form from array data.

Link to comment
Share on other sites

I try to simplify FormHelper to not duplicate simple form api features (add, remove and modify form fields via form object). FormHelper should help to create fields based on a data array, handle file upload and also sanitizing form values.

So I remove some features (move field, ...) could easily done by form api.

Link to comment
Share on other sites

  • 2 weeks later...

Initial post updated after release FormHelper 0.1.0.

Many changes done and so it's not compatible to earlier versions!

  • create form from page, template or array data
  • Added possibility to update form fields (values, attributes) and field options (skip, unformatted, value, sanitizer) before render()

    -> "skip" a field have to be added by options() method before(!) createForm()

    -> use "value" to overwrite or clear the field value

    -> "unformatted" prefill the form with the unformatted page field value

    -> "sanitizer" defines the sanitizer to use. If isn't set You'll get the raw value!

  • get field values sanitized if a sanitizer is set via value() method
  • It's possible to chain createForm(), add(), update(), options() and render(), but this could be removed in future versions again...
  • ckeditor regular and inline mode (requires JqueryCore and JqueryUI modules!)
  • file / image upload / delete

Example login from with modified submit button

$formSubmit = array('vars' => array('name' => 'submit'), 'attr' => array('value' => 'Login'));
$formFields = array(
    'username' => array(
        'module'    => 'InputfieldText',
        'options'   => array('sanitizer' => 'username'),    // possible options are sanitizer, value, skip and unformatted
        'vars'      => array('name' => 'username', 'label' => 'Username', 'required' => true),
        'attr'      => array('id+name' => 'username'),
    'password' => array(
        'module'    => 'InputfieldText',
        'options'   => array('value' => ''),    // set field to empty
        'vars'      => array('name' => 'password', 'label' => 'Password', 'required' => true, 'type' => 'password'),
        'attr'      => array('id+name' => 'password', 'type' => 'password'),
$fh->update('submit', $this->formSubmit);
New method value() to get sanitized values
    // get sanitized field value if a sanitizer is set via field options
    $sanitizedUsername = $fh->value('username');
    // get raw value without sanitized (skip sanitizer is set!)
    $rawUsername = $fh->value('username', false);
Link to comment
Share on other sites

Version 0.3.0 released with bug fixes and improvements.

I try to get closer to a final release...


  • getForm()
  • getField($fieldname)
  • getInput()

and changed class variables to protected.


  • file handling if form was send with form errors (file changes won't saved during next try...)

Ideas, feedback and also pull requests are welcome ;)

Link to comment
Share on other sites

After some reading about honeypot I tested simple implementations. It should be quite simple.

Define the fields

        $this->honeypot['text'] = array(
            'module'    => 'InputfieldText',
            'options'   => array('sanitizer' => 'text', 'value' => 'http://'),
            'vars'      => array('name' => 'hp_website', 'label' => __('Do not change if you\'re human!')),
            'attr'      => array ('id+name' => 'hp_website', 'value' => 'http://'),
        $this->honeypot['checkbox'] = array(
            'module'    => 'InputfieldCheckbox',
            'options'   => array('sanitizer' => 'text', 'value' => ''),
            'vars'      => array('name' => 'hp_sendmail', 'label' => __('Do not check if you\'re human!')),
            'attr'      => array ('id+name' => 'hp_sendmail', 'value' => ''),

Add the fields to the form (for testing added to createForm before adding the submit button).


And check the values during processForm method.

        if ($this->value('hp_website') != 'http://') {
            $honeypot = $this->getField('hp_website');
            $honeypot->error(__('Value was changed! Are you a spam bot?!'));
        if ($this->value('hp_sendmail') == 1) {
            $honeypot = $this->getField('hp_sendmail');
            $honeypot->error(__('Value was changed! Are you a spam bot?!'));

So if the text field modified or the checkbox was checked, you'll get an error and form process stops.

Last step is to add css / js to hide the form fields to human visitors.

What do you think about a honeypot feature? Should it be added to FormHelper module? Which fields (website or better email?) or types of honeypot should be added?

Link to comment
Share on other sites

  • 1 month later...

I rewrite FormHelper to use the native array support of form api and noticed that form based on a template won't work with newer PW dev version. I get an error message from PagefilesManager.

Fatal error: Exception: New page '/pw//' must be saved before files can be accessed from it (in /volume1/web/pw/wire/core/PagefilesManager.php line 260) #0 /volume1/web/pw/wire/core/PagefilesManager.php(251): PagefilesManager->___path() #1 /volume1/web/pw/wire/core/PagefilesManager.php(211): PagefilesManager->path() #2 /volume1/web/pw/wire/core/PagefilesManager.php(67): PagefilesManager->createPath() #3 /volume1/web/pw/wire/core/PagefilesManager.php(55): PagefilesManager->init(Object(Page)) #4 /volume1/web/pw/wire/core/Page.php(1752): PagefilesManager->__construct(Object(Page)) #5 /volume1/web/pw/wire/core/Pagefiles.php(74): Page->filesManager() #6 /volume1/web/pw/wire/core/Pagefiles.php(58): Pagefiles->setPage(Object(Page)) #7 /volume1/web/pw/wire/modules/Fieldtype/FieldtypeImage.module(33): Pagefiles->__construct(Object(Page)) #8 /volume1/web/pw/wire/core/Fieldtype.php(390): FieldtypeImage->getBlankValue(Object(Page), Object(Field)) #9 /volume1/web/pw/wire/core/Page.php(817): Fieldtype->getDefaultValue(Object(Page), Ob in /volume1/web/pw/index.php on line 243
Error: Exception: New page '/pw//' must be saved before files can be accessed from it (in /volume1/web/pw/wire/core/PagefilesManager.php line 260)

#0 /volume1/web/pw/wire/core/PagefilesManager.php(251): PagefilesManager->___path()
#1 /volume1/web/pw/wire/core/PagefilesManager.php(211): PagefilesManager->path()
#2 /volume1/web/pw/wire/core/PagefilesManager.php(67): PagefilesManager->createPath()
#3 /volume1/web/pw/wire/core/PagefilesManager.php(55): PagefilesManager->init(Object(Page))
#4 /volume1/web/pw/wire/core/Page.php(1752): PagefilesManager->__construct(Object(Page))
#5 /volume1/web/pw/wire/core/Pagefiles.php(74): Page->filesManager()
#6 /volume1/web/pw/wire/core/Pagefiles.php(58): Pagefiles->setPage(Object(Page))
#7 /volume1/web/pw/wire/modules/Fieldtype/FieldtypeImage.module(33): Pagefiles->__construct(Object(Page))
#8 /volume1/web/pw/wire/core/Fieldtype.php(390): FieldtypeImage->getBlankValue(Object(Page), Object(Field))
#9 /volume1/web/pw/wire/core/Page.php(817): Fieldtype->getDefaultValue(Object(Page), Ob
This error message was shown because site is in debug mode ($config->debug = true; in /site/config.php). Error has been logged.

In the past it was possible to work with a "fake Page object" to get a working form and take care about page save later...

        $fakePage = new Page();
        $fakePage->template = $tpl;

So maybe form based on a template won't work and so won't implemented in future versions :(

Or is there a solution to get it working again without an existing page?

I used template based forms to create new pages, but page is saved after form is processed and data is checked...

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By LuisM
      Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider
      It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.
      The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.
      You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire
      The Symprowire Wiki https://github.com/Luis85/symprowire/wiki How to create a simple Blog with Symprowire https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial Last Update
      16.07.2021 // RC 1 v0.6.0 centralized ProcessWire access trough out the Application by wrapping to a Service https://github.com/Luis85/symprowire/releases/tag/v0.6.0-rc-1 Requirements
      PHP ^7.4 Fresh ProcessWire ^3.0.181 with a Blank Profile Composer 2 (v1 should work, not recommended) The usual Symfony Requirements Features
      Twig Dependency Injection Monolog for Symprowire Support for .env YAML Configuration Symfony Console and Console Commands Symfony Webprofiler Full ProcessWire access inside your Controller and Services Webpack Encore support Caveats
      Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

      So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env
    • By FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      Github repository:
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      New in version 1.1.0
      A new feature comes with version 1.1.0 which offers to record user names of loggedin visitors. Just activate "Record user names" and "Record loggedin user" in the module settings.
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By clsource
      Inertia Adapter ProcessWire Module
      Hello! Long time no see.
      I created this module so you can use Inertia.js (https://inertiajs.com/) with ProcessWire.
      Inertia allows you to create fully client-side rendered, single-page apps, without much of the complexity that comes with modern SPAs. It does this by leveraging existing server-side frameworks.
      Inertia isn’t a framework, nor is it a replacement to your existing server-side or client-side frameworks. Rather, it’s designed to work with them. Think of Inertia as glue that connects the two. Inertia comes with three official client-side adapters (React, Vue, and Svelte).
      This is an adapter for ProcessWire. Inertia replaces PHP views altogether by returning JavaScript components from controller actions. Those components can be built with your frontend framework of choice.
      - https://github.com/joyofpw/inertia
      - https://github.com/joyofpw/inertia-svelte-mix-pw
      - https://inertiajs.com/

    • By sms77io
      Hi all,
      we made a small module for sending SMS via Sms77.io. It supports sending to one and multiple users.
      You can download it from GitHub and follow the instructions on how to install it - it is quite easy. An API key is required for sending, get yours for free @ Sms77 and receive 0,50 €.
      Hope this helps somebody and we are open for improvement suggestions!
      Best regards
  • Create New...