justb3a

Simple Contact Form

Recommended Posts

I have a small request: form data should be stored regardless whether a mail has been sent or not. Just in case, someone forgets to install sendmail on their DigitalOcean server :D (or, on a more serious note, a component in the notification chain is failing)

Share this post


Link to post
Share on other sites

Who would forget this ??  :P  ^_^

v0.2.1 - Regardless whether a mail has been sent or not, if saveMessages is enabled, the data will be stored. Besides a corresponding log entry will be saved.

  • Like 2

Share this post


Link to post
Share on other sites

Great module, thanks for sharing. I was interesting in adding the new Google Recaptcha in addition to the honeypot. Has anyone had any luck doing so and if so any suggestions on the best approach to add it?

Thanks

Share this post


Link to post
Share on other sites

Hi all,

the module version 0.2.1 claims compatibility with PW 2.5, 2.6, 2.7 -  but not 3.0.

I tried to use it in PW 3.0.10 devns, and it works like expected as long as I leave the setting saveMessages unticked.

Checking this option throws the following message:

Fatal error: Call to a member function find() on a non-object in  ...../site/assets/cache/FileCompiler/site/modules/SimpleContactForm/SimpleContactForm.module on line 747

Line 747 of that file is

        $spamMailsMsgs = $receivedMessages->find('scf_spamMail!=');

Most likely it's some other problem and not the PW version causing this error.

But for compatibility, would it help to replace the  <?php  by  <?php namespace ProcessWire; in all the php files of the module, or is there more to do to get it compatible?
 

Share this post


Link to post
Share on other sites

Most likely it's some other problem and not the PW version causing this error.

But for compatibility, would it help to replace the  <?php  by  <?php namespace ProcessWire; in all the php files of the module, or is there more to do to get it compatible?

Replacing the php tag with the one containing the namespace isn't the solution. Modules without namespace declarations should also function in PW3.x. At the moment I'm working on a new version supporting PW3.x. I guess I'll finish that this week (the next release will provide further improvements as well).  :)

  • Like 1

Share this post


Link to post
Share on other sites

If you want to use this module with PW3.x (and only PW3.x), please pull branch feature/devns. It needs a bit more testing before I'll release it. 

  • first backup your installation
  • after upgrading the module, go to module settings, have a look at the settings – you may have to adapt something

Whats new:

  • messages will be saved as pages instead of repeater items
  • you have to define a parent page, all messages created will live under this parent
  • the page name starts with the current timestamp, you could add additional fields which should be appended
  • field selection: you can existing fields or fill in field names, after the module are saved, for each name a field will be created
  • manage settings like field type, required, additional error checks for each field
  • after the module settings are saved, all existing repeater items will be converted to pages
  • no more template creation, ProcessWire API renders the form (you can adapt the markup)
  • you may have to translate error and success messages

Have a look at the latest readme to get more information. I would love to get some feedback  ;)

  • Like 5

Share this post


Link to post
Share on other sites

Hi, and thank you for this module!

I've been trying get the feature/devns branch to work with PW 3.0.14 but ran into a problem.

I try to render the form as below:

82         <?php echo $modules->get('SimpleContactForm')->render(); ?>

and the form shows up but with the following message:

Notice: Trying to get property of non-object in /site/templates/_main.php on line 82

If I fill in the form and press send I get a "Your contact request has been send successfully!" message, and when I check the Simplecontactform-log it has a success entry. It seems like it's working so why do I get the error message on line 82? 

Thanks in advance!

Share this post


Link to post
Share on other sites

Hi @Piqsel, thanks for the feedback.

I just installed a fresh PW 3.0.14 installation, downloaded SimpleContactForm branch feature/devns, filled in module settings. Then I added 

echo $modules->get('SimpleContactForm')->render(); to home.php.
But I can't reproduce the message you received. Everything works as expected. Do you include the module call inside _main.php? Because the error notice refers to line 82 of /site/templates/_main.php and not to /site/modules/SimpleContactForm/xxx. Furthermore the module call doesn't include a property request. Apart from this you said the module seems to work, so maybe this error notice isn't related? Could you please try to restrict the issue by debugging the parts one after the other? [var_dump($modules); var_dump($modules->get('SimpleContactForm'));] You have to find out which part produces the error message.

Share this post


Link to post
Share on other sites

Hi @justb3a,

thanks for the module. I am currently trying to use SimpleContactForm (PW 2.7.2 // SCF 0.2.1) with two templates on one page (for contacting the owner and for signing up to the newsletter (e-mail and printed)). I was trying to use: 

$options = array (
  'submitName' => 'newname'

but this caused the whole page to throw an error. Would be great if you would have a hint for me to get submitName to work.

Is there a way to prevent the form to load the homepage when an error occurs. When using ajax I would like the form to set some classes on the erroneous fields – did I miss something?

Thanks for your feedback,

Depone

Share this post


Link to post
Share on other sites

Hi,

here is a working example of one of my latest projects on how to use more than one contact form on a single page (PW 2.x):

$optionsContact = array(
  'submitName' => 'submit-contact',
  'templateName' => 'estate-contact-request'
);
    
echo $modules->get('SimpleContactForm')->render($optionsContact);

$optionsRecommend = array(
'allFields'=> $allFields,
'requiredFields' => $allFields,
'submitName' => 'submit-recommend',
'templateName' => 'estate-recommend',
'emailSubject' => 'xxx',
'emailMessage' => $emailMessage,
'successMessage'=> $successMessage
);

echo $modules->get('SimpleContactForm')->render($optionsRecommend);

You can override every option from the module settings,. If you skip an option, the one from module settings will be used. So you don't have to pass any option to the first render call. Then you need to adapt the JavaScript to trigger the related form. If you pass another template you have to create it manually (by copying the generated one and then adapted it to the special needs, make sure to change the submitName).

If an error occurs, please let me know, what the error message is and when it appears (rendering the form, submitting the form, using ajax...).

Is there a way to prevent the form to load the homepage when an error occurs. When using ajax I would like the form to set some classes on the erroneous fields – did I miss something?

I noticed already that this wasn't the best idea and changed this behaviour in the devns branch (PW 3.0.x compatibility). Unfortunately there is no way to achieve the same in the "old" version working with PW below 3.x.

Share this post


Link to post
Share on other sites

Hi @justb3a,

thank you very much for your fast reply. The submitName is now working. I forgot to explicitly set a templateName on both instances, because I assumed it would fallback to the default if nothing is declared. If I set templateName and submitName on both it works.

Thanks for the description of the submit-behavior. I am currently highlighting the required fields if the user moves forward without filling them out, what seems as a legit workaround.

With one form I am running into – [FAILURE] Number of fields does not match. – even though the same hidden fields are available as on the other form. The form itself has one more field than the other one, but I set them with the allFields-key. Do you have a hint for me what I might have overlooked?

Thanks,

Depone

Edit 2016-04-14: fixed – error was caused by a field-name mismatch. 

  • Like 1

Share this post


Link to post
Share on other sites

This modal is ace but super confusing for optional use.

trying to get a second form (not on the same page) with different options and but it doesnt seem to render. e.g.

$options = array(
      'allFields' => 'email',
    );

    echo $modules->get('SimpleContactForm')->render($options);

for example this simply gives me the same form from the module settings.

doing the above with submitName, and templateName crashes and means in need to make a new template... (but why?) so i made a new template but now im getting my site twice (modal), so i exclude the _init and _main, but then the from doesnt show, should it be added to the new template now??

sorry if im missing something

Share this post


Link to post
Share on other sites

Hi @benbyf, I had the same situ until I spotted that I had not followed the instructions properly, maybe you did what I did—I copied the file `simple_contact_form.php` to a new template called `simple_membership_form.php` but then forgot to create a new corrosponding template in the PW admin. So I did that. That nearly fixed it but I guessed perhaps the plain template I had created was in some way not like the one that ships so I deleted the template I'd made in the PW Admin and instead used the Admin to make a copy of the template that ships and then changed it's name and told it to use the file `simple_membership_form.php` and it worked AOK.

Good luck! :)

I had to stop using the form for a second form as the second form needed radio options and I couldn't work out how to do that :( I might come back to ask if it turns out I can't do w/o the form :)

Share this post


Link to post
Share on other sites

I assume you 're using PW 2.7.x and the latest stable version of the module (master branch / ProcessWire module directory).

If the second form contains different fields than the first one, you need to pass a lot more params as only the 'allFields' key.

(at least requiredFields, emailFields, templateName).

As I said before the module for PW3 changed a lot and also got an improved Readme.  

If you still run into trouble, please provide an example which I can reproduce and document  ;)

(Module settings for the first form and the difference to the second one).

  • Like 1

Share this post


Link to post
Share on other sites

Thanks @justb3a if that kind offer to document was re my possible use case, most appreciated :)

Right now I have sidestepped the requirement but if I find I need it and can't work it out I will reply here in case you have a chance to doc then :)

PS: I am using latest production 2.7 PW and latest 2.7 ver of your module (I can't move to PW 3 as I am using @kongondo's fabulous blog module which I think is not fully ready for PW 3 (sorry if I am out of date on that assumption).

Share this post


Link to post
Share on other sites

on submit the form sends me to the hompage, anyone happen to know why this might be happening?

Share this post


Link to post
Share on other sites

Hi benbyf,

Check the error log. You are likely not passing validation and getting spammed out. Check this forum on how to address it. I can't find the post right now, but will link to it when I do.

Share this post


Link to post
Share on other sites

good call, got this: Number of fields does not match

Share this post


Link to post
Share on other sites

added the Inputs and system count to the module so that it read to the logs and I got this: 2016-04-22 18:18:20    [FAILURE] Number of fields does not match. Input:7 System:9.

seems that some fields arent being submitted. do I need to specify the spam fields or thing in the submission...?

Share this post


Link to post
Share on other sites

Do all your fields match up on your form to what the module has generated? Check your template field names against what is in the module settings. Make sure you save the module if you have updated or changed any fields.

Also check the antiSpamCountAdditonalInputs in the module settings and make sure those fields exist in your template.

  • Like 1

Share this post


Link to post
Share on other sites

thats fixed it. although it does say in the module settings that these get added automatically, which in this case is obviously not true.

Share this post


Link to post
Share on other sites

Hi @justb3a,

to assist the receiver in answering to the sender, I would like to add a Reply-To-Header to the form. 

To achieve this I have added the following code to SimpleContactForm.module: 

// Set variable for E-Mail-Address to reply to
    foreach ($this->emailFields as $emailField) {
      $replyToEmail = $this->sanitizer->email($this->input->post->{$emailField});
    }
// Add Reply-To header
      $wireMail->header('Reply-To', $replyToEmail);

Would this be a feature you’d like to add to the Module? 

If yes I could fork the Repo on Github and create a Pull Request …

Share this post


Link to post
Share on other sites

hi @depone,

I assume you're referring to the latest master version which is only compatible with PW 2.x. I don't want to add any features to this version anymore. Sorry for that. But I decided to add this feature to the feature/devns branch which supports PW 3.x. There is a new module setting where you're able to set a reply-to email address. If you want to use a value from the entries of the form, you have to pass this as an option to the render function:

$options = array('emailReplyTo' => $input->scf_email);
echo $modules->get('SimpleContactForm')->render($options);
  • Like 1

Share this post


Link to post
Share on other sites

Hi all,

the module version 0.2.1 claims compatibility with PW 2.5, 2.6, 2.7 -  but not 3.0.

I tried to use it in PW 3.0.10 devns, and it works like expected as long as I leave the setting saveMessages unticked.

Checking this option throws the following message:

Line 747 of that file is

        $spamMailsMsgs = $receivedMessages->find('scf_spamMail!=');

Most likely it's some other problem and not the PW version causing this error.

But for compatibility, would it help to replace the  <?php  by  <?php namespace ProcessWire; in all the php files of the module, or is there more to do to get it compatible?

Same issue in ProcessWire 2.7.2 for me. Uhm?

--- Edit:

Fixed it: https://github.com/justonestep/processwire-simplecontactform/pull/4

Edited by Tramvai

Share this post


Link to post
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 noelboss
      Page Query Builder
      Build complex nested queries containing multipple fields and pages and return an array that can be parsed to JSON. This is usefull to fetch data for SPA and PWA.
      You can use it to tranfrom a ProcessWire Page or PageArray, even RepeaterMatrixPageArrays into an array or JSON. Queries can be nested and contain closures as callback functions.
      Installation
      Via ProcessWire Backend
      It is recommended to install via the ProcessWire admin Modules > Site > Add New > Add Module from Directory using the PageQueryBuilder class name.
      Manually
      Download the files from Github or the ProcessWire repository: https://modules.processwire.com/modules/page-query-builder/
      Copy all of the files for this module into /site/modules/PageQueryBuilder/ Go to “Modules > Refresh” in your admin, and then click “install” for the this module. Methods
      There are two main methos:
      Return JSON
      $page->pageQueryJson($query); Return an Array
      $page->pageQueryArray($query); Building the query
      The query can be with key value pairs, or only keys. and can be nested. To ilustrate a short example:
      // simple query: $query = [ 'height', 'floors', ]; $pages->find('template=skyscraper')->pageQueryJson($query); Queries can be nested, call children etc:
      // simple query: $query = [ 'height', 'floors', 'images', // < some fileds contain default sub-queries to return data 'files' => [ // but you can also overrdide these defaults: 'filename' 'ext', 'url', ], // Assuming there are child pages with the architec template, or a // field name with a page relation to architects 'architect' => [ // sub-query 'name', 'email' ], // queries can contain closure functions 'querytime' => function($parent){ return "Query for $parent->title was built ".time(); } ]; $pages->find('template=skyscraper')->pageQueryJson($query); Keys:
      A single fieldname; height or floors or architects 
      The Module can handle the following fields:
      Strings, Dates, Integer… Page references Pageimages Pagefiles PageArray MapMarker FieldtypeFunctional A template name; skyscraper or city
      The fieldname of a child (child.name); url or filename or title
      A ProcessWire selector; template=building, floors>=25
      A new name for the returned index passed by a # delimiter:
      $query = [ 'skyscraper' => [ 'height', 'floors' ], 'architect' => [ 'title', 'email' ], ]  
      Key value pars:
      Any of the keys above with an new query array:
      $query = [ 'skyscraper' => [ 'height', 'floors' ], 'architect' => [ 'title', 'email' ], ]  
      A key and a closure functions to process and return a query. The closure gets the parent as argument:
      $query = [ 'architecs' => function($parent) { $architects = $parent->find('template=architect'); return $architects->arrayQuery(['name', 'email']); // or return $architects->explode('name, email'); } ] Real life example:
      $query = [ 'title', 'subtitle', // naming the key invitation 'template=Invitation, limit=1#invitation' => [ 'title', 'subtitle', 'body', ], // returns global speakers and local ones... 'speakers' => function($page){ $speakers = $page->speaker_relation; $speakers = $speakers->prepend(wire('pages')->find('template=Speaker, global=1, sort=-id')); // build a query of the speakers with return $speakers->arrayQuery([ 'title#name', // rename title field to name 'subtitle#ministry', // rename subtitle field to ministry 'links' => [ 'linklabel#label', // rename linklabel field to minlabelistry 'link' ], ]); }, // ProcessWire selector > name result "location" 'template=Location, limit=1#location' => [ 'title#city', // summary title field to city 'body', 'country', 'venue', 'summary#address', // rename summary field to address 'link', // ticket link 'map', // Mapmarker field, automatically transformed 'images', 'infos#categories' => [ // repeater matrix! > rename to categories 'title#name', // rename title field to name 'entries' => [ // nested repeater matrix! 'title', 'body' ] ], ], ]; if ($input->urlSegment1 === 'json') { header('Content-type: application/json'); echo $page->pageQueryJson($query); exit(); } Module default settings
      The modules settings are public. They can be adjusted, for example:
      $modules->get('PageQueryBuilder')->debug = true; $modules->get('PageQueryBuilder')->defaults = []; // reset all defaults Default queries for fields:
      Some field types come with default selectors, like Pageimages etc. These are the default queries for template names or object types:
      public $defaults = [ 'queries' => [ 'Pageimages' => [ 'basename', 'url', 'httpUrl', 'description', 'ext', 'focus', ], 'Pagefiles' => [ 'basename', 'url', 'httpUrl', 'description', 'ext', 'filesize', 'filesizeStr', 'hash', ], 'MapMarker' => [ 'lat', 'lng', 'zoom', 'address', ], 'User' => [ 'name', 'email', ], ], ]; These will only be used if there is no nested query for these types. So if you query a field with complex data and do not provide a sub-query, it will be transformed acordingly:
      $page->pageQueryArry(['images']); // returns something like this 'images' => [ 'basename', 'url', 'httpUrl', 'description', 'ext', 'focus'=> [ 'top', 'left', 'zoom', 'default', 'str', ] ]; You can always provide your own sub-query so the defaults will not be used:
      $page->pageQueryArry([ 'images' => [ 'filename', 'description' ], ]); You can also override these, for example:
      $modules->get('PageQueryBuilder')->defaults['queries']['Pageimages'] = [ 'basename', 'url', 'description', ]; Index of nested elements
      The index for nested elements can be adjusted. This is also done with defaults. There are 3 possibilities:
      Nested by name (default) Nested by ID Nested by nummerical indey Named index (default):
      This is the default. If you have a field that contains subpages, their key will be their name:
      // example $pagesByName = [ 'page-1-name' => [ 'title' => "Page one title", 'name' => 'page-1-name', ], 'page-2-name' => [ 'title' => "Page two title", 'name' => 'page-2-name', ] ] ID based index:
      If an object is listed in $defaults['index-id'] their index will be their id. Currently, no items are listed as defautls:
      $modules->get('PageQueryBuilder')->defaults['index-id']['Page']; // example $pagesById = [ 123 => [ 'title' => "Page one title", 'name' => 123, ], 124 => [ 'title' => "Page two title", 'name' => 124, ] ] Number based index
      By default, a couple of fields are transformed automatically to contain numbered indexes:
      // objects or template names that should use numerical indexes for children instead of names $defaults['index-n'] => [ 'Pageimage', 'Pagefile', 'RepeaterMatrixPage', ]; // example $images = [ 0 => [ 'filename' => "image1.jpg", ], 1 => [ 'filename' => "image2.jpg", ] ] When you remove the key 'Pageimage' from $defaults['index-n'], the index will again be name-based.
      Debug
      The module respects wire('config')->debug. It integrates with TracyDebug. You can override it like so:
      // turns on debug output no mather what: $modules->get('PageQueryBuilder')->debug = true; Todos
      Make defualts configurable via Backend. How could that be done in style with the default queries?
    • By daniels
      General
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns You can find it here: https://github.com/danielstieber/SubscribeToMailchimp
      Let me know what you think and if I should add it to the Modules Directory.
      Setup
      Log into your Mailchimp account and go to  Profile > Extras > API Keys. If you don't have an API Key, create a new one. Copy your API Key and paste it in the module settings (Processwire > Modules > Site > SubscribeToMailchimp). Back in Mailchimp, go to the list, where you want your new subscribers. Go to Settings > List name and defaults. Copy the List ID an paste it in to the module settings.
      Usage
      To use the module, you need to load it into your template:
      $mc = $modules->get("SubscribeToMailchimp"); Now you can pass an email address to the module and it will try to edit (if the user exists) or create a new subscriber in your list.
      $mc->subscribe('john.doe@example.com'); You can also pass a data array, to add additional info.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe']); You can even choose an alternative list, if you don't want this subscriber in your default list.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe'], 'abcdef1356'); // Subscribe to List ID abcdef1356 If you want to unsubscribe a user from a list, you can use the unsubscribe method.
      $mc->unsubscribe('john.doe@example.com'); // Unsubscribe john.doe@example.com from the default list $mc->unsubscribe('john.doe@example.com', 'abcdef1356'); // Unsubscribe john.doe@example.com from the list abcdef1356 If you want to permantly delete a user, you can call the delete method. Carefully, this step cannot be undone
      $mc->delete('john.doe@example.com'); // Permanently deletes john.doe@example.com from the default list $mc->delete('john.doe@example.com', 'abcdef1356'); // Permanently deletes john.doe@example.com from the list abcdef1356  
      Important Notes
      This module does not do any data validation. Use a sever-sided validation like Valitron Make sure that you have set up your fields in your Mailchimp list. You can do it at Settings > List fields and *|MERGE|* tags Example
      Example usage after a form is submitted on your page:
      // ... validation of form data $mc = $modules->get("SubscribeToMailchimp"); $email = $input->post->email; $subscriber = [ 'FNAME' => $input->post->firstname, 'LNAME' => $input->post->lastname, ]; $mc->subscribe($email, $subscriber);  
      Troubleshooting
      In case of trouble check your ProcessWire warning logs.
      I can't see the subscriber in the list
      If you have enabled double opt-in (it is enabled by default) you will not see the subscriber, until he confirmed the subscription in the email sent by Mailchimp
      I get an error in my ProccessWire warning logs
      Check if you have the right List ID and API Key. Check if you pass fields, that exist in your list. Check if you pass a valid email address. Go to Mailchimps Error Glossary for more Information
      How To Install
      Download the zip file at Github or clone directly the repo into your site/modules If you downloaded the zip file, extract it in your sites/modules directory. You might have to change the folders name to 'SubscribeToMailchimp'. Goto the modules admin page, click on refresh and install it  
      Changelog
      0.0.2
      Note: You can update safely from 0.0.1 without any changes in your code
      New Features
      Added 'Unsubscribe' method $mc->unsubscribe($email, $list = "") Added 'Delete' method $mc->delete($email, $list = "") Bug Fixes and compatibility changes
      Removed type declarations to be compatible with PHP 5.1+* (thanks to wbmnfktr) Other
      Changed the way, the base url for the api gets called *I have only tested it with PHP 7.x so far, so use on owners risk
    • By BitPoet
      As threatened in the Pub sub forum in the "What are you currently building?" thread, I've toyed around with Collabora CODE and built file editing capabilities for office documents (Libre-/OpenOffice formats and MS Office as well as a few really old file types) into a PW module.
      If you are running OwnCloud or NextCloud, you'll perhaps be familiar with the Collabora app for this purpose.
      LoolEditor
      Edit office files directly in ProcessWire
      Edit your docx, odt, pptx, xlsx or whatever office files you have stored in your file fields directly from ProcessWire's page editor. Upload, click the edit icon, make your changes and save. Can be enabled per field, even in template context.
      Currently supports opening and saving of office documents. Locking functionality is in development.
      See the README on GitHub for installation instructions. You should be reasonably experienced with configuring HTTPS and running docker images to get things set up quickly.
      Pull requests are welcome!
      Here is a short demonstration:

    • By Robin S
      An Images field allows you to:
      Rename images by clicking the filename in the edit panel or in list view. Replace images, keeping metadata and filename (when possible) by dropping a new image on the thumbnail in the edit panel. Introduced here. But neither of these things is possible in File fields, which prompted this module. The way that files are renamed or replaced in this module is not as slick as in the Images field but it gets the job done. The most time-consuming part was dealing with the UI differences of the core admin themes. @tpr, gives me even more respect for the work that must go into AdminOnSteroids.
      Most of the code to support the rename/replace features is already present in InputfieldFile - there is just no UI for it currently. So hopefully that means these features will be offered in the core soon and this module can become obsolete.
       
      Files Rename Replace
      Allows files to be renamed or replaced in Page Edit.

      Usage
      Install the Files Rename Replace module.
      If you want to limit the module to certain roles only, select the roles in the module config. If no roles are selected then any role may rename/replace files.
      In Page Edit, click "Rename/Replace" for a file...
      Rename
      Use the text input to edit the existing name (excluding file extension).
      Replace
      Use the "Replace with" select to choose a replacement file from the same field. On page save the file will be replaced with the file you selected. Metadata (description, tags) will be retained, and the filename also if the file extensions are the same.
      Tip: newly uploaded files will appear in the "Replace with" select after the page has been saved.
       
      https://github.com/Toutouwai/FilesRenameReplace
      http://modules.processwire.com/modules/files-rename-replace/
    • By d'Hinnisdaël
      So I decided to wade into module development and created a wrapper module around ImageOptim, a service that compresses and optimizes images in the cloud. ImageOptim currently handles JPG, PNG and GIF files and, depending on the settings you use, shaves off between 15% and 60% in filesize. Great for bandwidth and great for users, especially on mobile.
      This module handles the part of uploading images to ImageOptim via their official API, downloading the optimized version and storing it alongside the original image.
       

       
      Download & Info
      GitHub / Module directory / Readme / Usage
       
      Why ImageOptim?
      There are other image optimization services out there, some of them free, that have outstanding ProcessWire modules. A few things make ImageOptim the best tool for most of my customers: It's not free, i.e. it will probably be around for a while and offers support. However, it's cheaper than some of the bigger competitors like Cloudinary. And it does PNG compression better than any of the free services out there, especially those with alpha channels.
       
      Installation
      Install the module like any other ProcessWire module, by either copying the folder into your modules folder or installing it via the admin. See above for downloads links on GitHub and in the module directory.
       
      Requirements
      To be able to upload images to the service, allow_url_fopen must be set on the server. The module will abort installation if that's not the case.
      I have only tested the module on ProcessWire 3.x installations. I don't see why it shouldn't work in 2.x, if anyone wants to try it out and report back.
       
      ImageOptim account
      To compress images, you first need to sign up for an ImageOptim account. They offer free trials to try the service.
       
      Usage (manual optimization)
      Images can be optimized by calling the optimize() method on any image. You can pass an options array to set ImageOptim API parameters.
      $image->size(800,600)->optimize()->url $image->optimize(['quality' => 'low', 'dpr' => 2]) // Set quality to low and enable hi-dpi mode
      Automatic optimization
      The module also has an automatic mode that optimizes all image variations after resizing. This is the recommended way to use this module since it leaves the original image uncompressed, but optimizes all derivative images.
      $image->size(800,600)->url // nothing to do here; image is optimized automatically
      To change compression setting for single images, you can pass an options array along with the standard ImageResizer options. Passing false disables optimization.
      $image->size(800, 600, ['optimize' => 'medium']) $image->size(800, 600, ['optimize' => ['quality' => 'low', 'dpr' => 2]]) $image->size(800, 600, ['optimize' => false])
      For detailed usage instructions and all API parameters, see the usage instructions on GitHub.
       
      Filenames
      Optimized images will be suffixed, e.g. image.jpg becomes image.optim.jpg. You can configure the suffix in the module settings.
       
      Roadmap
      Asynchronous processing. Not really high on the list. Image variations need to be created anyway, so waiting a few seconds longer on first load is preferable to adding complexity to achieve async optimization. Optimize image variations created by other modules. CroppableImage comes to mind. I don't use any of these, so if somebody wants to help out and submit a pull request — all for it! Add a dedicated page in the setup menu with a dashboard and detailed statistics. ImageOptim's API is very barebones for now, so not sure if that's feasible or even necessary.
      Stability
      I've been using this module on production sites for some time now, without hiccups. If you do notice oddities, feel free to comment here or investigate and submit PRs.