Jump to content

FrontendUser: login, logout and register users / members


Recommended Posts

The FrontendUser module provides a frontend login, logout and user registration functionality.


See module documentation for details.

  • login with error handling and value sanitizing
  • Plugin: ProcessForgotPassword core module integration
  • Plugin: LoginPersist module integration
  • user registration with username and email address already in use check
  • email adress pre-register validation (email verification)
  • Extendable with additional fields and by PW hooks
  • forms generated by PW form api
  • Custom style / script 




ToDo / Issues

I hope it will be helpful to the community and I would be glad to get feedback or suggestions for improvement!

  • Like 8
Link to comment
Share on other sites

Hi pwFoo. I've tried to install first FormHelper on a clean local installation with Mamp Pro (PW 2.5.29, PHP 5.6.2). FormHelper.module was installed properly, but the FormHelperExtra.module gives me the following error: "Unable to install module 'FormHelperExtra': Can't save page 0: /fhstorage/: It has no parent assigned".


Link to comment
Share on other sites

Hello jacmaes,

fhstorage is a hidden admin page to handle file uploads to not existing pages (during frontend page creation for example). It should be added and removed during FormHelperExtra module un-/install. I'll take a look at it later.

But FormHelperExtra isn't needed! Just install FormHelper and FrontendUser modules and it should work.

Link to comment
Share on other sites

Thanks. I realize that FormHelperExtra was not needed, so I went ahead and successfully installed everything else. The login and registration process work fine in my test environment, and it's pretty easy and quick to implement. Great job. 

Now I'd like to go one step further, and allow users to edit their profiles (after adding fields to the user template like "first name", "last name" and "birthdate" for example). I believe that FormHelper should help out with this, but how should I proceed? Could you add a simple example to the module docs? 

Link to comment
Share on other sites

I should be easy to extend the register form with additional fields (like done with the login and register plugins examples).

A FrontendUserProfile is planned and should be easy to build with the FormHelper module (and also without, but I like it ;) It simplify some tasks like sanitize values or form processing). Maybe ProcessProfile core module could do the job...

I take a look and maybe add a simple example, but that should be moved to the FormHelper topic.

  • Like 1
Link to comment
Share on other sites

Here is the source code of the LoginPersist integration.

        $persist = $this->modules->get('InputfieldCheckboxes');
        $persist->name = 'persist';
        $persist->attr('id+name', 'persist');
        $persist->skipLabel = 4;
        $persist->addoption('persist', $this->_('Remember me?'));
        $persist->addHookAfter('Session::login', function($event) use (&$persist) {
            if (isset($persist->value[0]) && $persist->value[0] === 'persist') {

The examples hook into existing form fields.

Add own fields (example "$myField") or change order

$fu->login(array('username', 'password', 'persist', 'forgot', $myField));

See basic usage

Link to comment
Share on other sites

Updated FU version 0.8.2 replaced hard coded verification email with simple html / plain templates to send an html email with wiremail. Has to be improved / changed in the future, but I don't know how I'll implement it (module configuration, template, ...) to keep it flexible and simple.

  • Like 1
Link to comment
Share on other sites

I have some problems with the email template / config. Subject and text should be configurable, but I won't write a template parser to replace tokens like 


or something similar. 

Write the text to the template isn't a good way and also not translatable.

So how should / could it be done a nice way?

  1. Set text block in module configuration to be shown before the token / link?
  2. Move the complex email verification plugin to a separated module file with own config section?
  3. Use a page for email subject / text to be translatable like other fields?
  4. ...

I try to build a universal usable login / register module, so suggestions and feedback is welcome! ;)

Link to comment
Share on other sites

Version 0.8.3

  • moved email validation to sub-module FrontendUserRegisterEmailValidation
  • Added FrontendUserRegisterEmailValidation module configuration (email subject and text)
  • Removed plain email template (now generated by php based on the html one)
  • simple example html email template
Link to comment
Share on other sites

Hi again ;-)

thanks for the tips regarding php 5.3 workaround - that did the trick!

Another (minor) issue I encountered is that the generated email will still append the "normal" _main.php template file, which results in a doubled html / body code and may confuse some mail clients. By changing the line


in FrontendUserRegisterEmailValidation.module the regex will strip out the _main.php tags as well, which for me right now works as a workaround, but of course I am wondering where I'd be able to undo the automatic appending of the _main.php … my guess is, that

$emailContentHtml = wire('page')->render($this->fu->getFile('validationEmail.php', 'templates'), $vars);

is the right place to look, but I've yet to find the correct setting for $vars. :-)


Link to comment
Share on other sites


sorry for being unclear, the email template is loaded, i.e. the infos and content etc are in the email. it's only that after that, the _main.php is included, as well, which in my case will add additional (and content-less) html,body,etc markup to the already existing html,body,etc markup in the mail's source code. :-) Changes to the email template are reflected in the mail sent. It's only the additional markup that I'm wondering about.

Link to comment
Share on other sites

ok. Maybe a prepand / append to template problem? Could you check the config file?

I load a custom template from module folder. Maybe I need another way to load it to prevent the template append / prepand...

Updated module to 0.8.4 / email validation plugin to 0.0.2. 

  • module instance / object is now available via wire('fu') to simplify plugin hooks and...
  • add PHP 5.3 compatibility :)

Minimum tested at the moment! Could you test it and post the results here?

  • Like 1
Link to comment
Share on other sites

Thanks for feedback. 

Is the template append problems also fixed with the new version?

Because that was also a anonymous function / php 5.3 problem.

Have to verified that the FrontendUserRegisterEmailValidation module configuration is working? It's used as email subject ($this->subject) an prepanded email text ($this->content). Works fine with php 5.5, but haven't tested it with php 5.3.

I merged your latest master with my local changes, keeping your 5.3 compat changes.

Could you tell me that you have changed? Customization should be possible without hack / modify the module. Just with PW hooks, custom plugins and additional fields ;)

Link to comment
Share on other sites


well, basically I added a function to send another mail after sucessful registration, and bypassed the need to login after the user has entered his/her desired password in the second step.

I can send you a pull request of my dev-branch if you like, but rather wouldn't have this public for now since we hard-coded some email adresses and client-related stuff into the code… may I mail you a zip or invite you to our bitbucket team so you can see the fork?
(it's all a bit rushed right now b/c it needs to work tomorrow morning (launch) :-D )

Link to comment
Share on other sites

The hole email verification (hide password field, add verification code field, process additional fields and send the email) is based on hooks without a FU module modification. ;)

Additional email and auto login should be done by an additional hook ;)

Maybe I can take a look in the evening, but don't know yet...

FrontendUser module should work fine, but keep in mind it's alpha at the moment and needs testing!

Link to comment
Share on other sites

the template append is still there.

here's a excerpt from the mail source code if the


is used, if I change this to


the mail is ok (due to the regex stripping I guess).

Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 7bit

        <p>Thank you, (snip snap) .... </p>
        <!-- empty line and comment only lines works as a linebreak with plain emails -->
        <p>User: Testtest<br />
        Email: test@test.te</p>

        <p>Code: 2b7d110cb29be35bbac13d506e02f7de</p>

        <p>Link: (domain)/registration/?registerToken=2b7d110cb29be35bbac13d506e02f7de</p>
<!DOCTYPE html>
<html lang="de">
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0">
    <script type="text/javascript" src="/site/templates/js/modernizr-custom.js"></script>

    <link rel="stylesheet" type="text/css" href="/site/templates/css/styles.css">

<body id="pid-1032" class="pid-1032 p-registration t-user_registration">
<div class="page">
            <main class="page-main">
        <!-- main content -->
    <footer class="page-footer">
        <div class="container">
<script type="text/javascript" src="/site/templates/js/jquery.min.js"></script>
<script type="text/javascript" src="/site/templates/js/scripts.js"></script>



The hole email verification (hide password field, add verification code field, process additional fields and send the email) is based on hooks without a FU module modification. ;)

Additional email and auto login should be done by an additional hook ;)

Maybe I can take a look in the evening, but don't know yet...

FrontendUser module should work fine, but keep in mind it's alpha at the moment and needs testing!

yes, and thank you for the alpha reminder ;-)
I need to learn the hook things better, and then I'll keep my fingers out of the module's code, promised! :-)

ah, and of course I don't expect you to tackle my problems here (just realised that the above may be read as "uh it's urgent, please have a look") but this is not how it was meant; I mentioned it only as an explanation why I hacked in your module's code :-))

Link to comment
Share on other sites

No problem. If you send me the additional code and I have the time I could rewrite it to a hook.

I would like to see the module used by the community and extended by hooks / plugins to keep the module core simple, clean and reusable ;)

Custom plugins could be added to my git repo / wiki to share with other PW users.

I'm also interested in feedback if you use it inside a project. Just to see how it could be improved.

  • Like 1
Link to comment
Share on other sites

Version 0.8.5

  • Add some more comments to FrontendUserRegisterEmailValidation module
  • FrontendUser::auth() is now hookable (to build a auto login after sucessful user registration)
  • Add usage shorthand to call login / register with one method call by set a second param ($redirect)
    // load module
    $fu = $modules->get('FrontendUser');
    // login
    echo $fu->login(null, $redirectDestination);   // with default fields
    //echo $fu->login(array('username', 'password', 'persist', 'forgot'), $redirectDestination);
    // load module
    $fu = $modules->get('FrontendUser');
    // registration
    echo $fu->register(null, $redirectDestination);  // with default fields
    //echo $fu->register(array('username', 'email', 'emailValidation', 'password'), $redirectDestination);

The compatibility to PHP 5.3 seems to work fine, but isn't fully tested. Because Processwire 2.5 / 2.6 requires PHP 5.3+ I would't increase the requirements to PHP 5.4 ;)

  • Like 2
Link to comment
Share on other sites

I'm testing the latest version, but:

Apache/2.2.23 (Unix) mod_ssl/2.2.23 OpenSSL/0.9.8r DAV/2 PHP/5.4.10

Compile Error: Can't use method return value in write context (line 63 of /Volumes/Docs/MAMP/htdocs/pwire_test05/site/modules/FrontendUser/FrontendUser/FrontendUserRegisterEmailValidation.module) 
Link to comment
Share on other sites

Hello Macrura,

line 63 of FrontendUserRegisterEmailValidation.module:

        if (empty(wire('session')->get('registerStep'))) {

Seems to be PHP < 5.5 related...


Prior to PHP 5.5, empty() only supports variables; anything else will result in a parse error. In other words, the following will not work: empty(trim($name)). Instead, use trim($name) == false.

 To be compatible with PHP 5.3 and 5.4 I have to check the usage of empty() in combination with wire() and replace such calls... I'll take a look later.

You could test this:

//        if (empty(wire('session')->get('registerStep'))) {
        $session = wire('session');
        if (empty($session->get('registerStep'))) {
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...