Jump to content
adrian

Email New User

Recommended Posts

This seems to be a very versatile and hackable module, thank you for creating it :)

I've already created a version, which only emails the admin, when a new user is created (=registers on their own).

Now I'm tinkering with a version, which only emails the user manually, with the "Send email" feature in the user page.

If I want to block the automatic emailing on user creation, is it enough to add

if(!$this->page->process == 'ProcessUser') return;

in the sendNewUserEmail function before the other exiting conditions?

I though I'd ask and share the inspiration, before I even put the site online and can actually test the emailing functionality :)

My goal is to import a bunch of users from another CMS, send them the welcome email on creation, then disable adrian's original module and enable my two modified modules permanently.

Share this post


Link to post
Share on other sites

Hi Beluga - glad you are finding it useful, although I have to wonder if your use case for emailing the admin when a new user registers couldn't be better handled by a separate custom module - most of the code from this module is likely not relevant.

I think your tinkering regarding a manual only send email feature might be a useful option for this module. It could be a configurable option that adds a checkbox to the user page which could be checked or unchecked by default which determines whether the email is sent or not when registering a new user - would that work for you?

Share this post


Link to post
Share on other sites

I think your tinkering regarding a manual only send email feature might be a useful option for this module. It could be a configurable option that adds a checkbox to the user page which could be checked or unchecked by default which determines whether the email is sent or not when registering a new user - would that work for you?

It sure would work. Thanks for considering it.

Share this post


Link to post
Share on other sites

Ok, there is a new version with a new config setting: Automatic Email Send. This is checked by default, but if you uncheck this, then when creating new users the Send Email checkbox will be unchecked by default, so you will need to manually check each time to want to email a new user upon creation. This setting also works with users added via the API. If unchecked, they won't be sent an email, so you will need to use:

$newuser->sendEmail = true;

to have the email sent.

Hope that meets your needs and others also find it useful!

  • Like 2

Share this post


Link to post
Share on other sites

Ok, now I got to test it on an online site.

Some notes:

- if creating users with CSV import, the pwd is generated only, if left blank in the CSV. If pwd exists in CSV, it won't be overwritten by a generated one. I don't know, if this is intentional, so decided to mention

- users registered via FrontendUser module will not trigger emails!

Here is the source for the FrontendUser module in Bitbucket.

Share this post


Link to post
Share on other sites
- if creating users with CSV import, the pwd is generated only, if left blank in the CSV. If pwd exists in CSV, it won't be overwritten by a generated one. I don't know, if this is intentional, so decided to mention

This is intentional - if you want the automatically generated password to be used, make sure the password field is not populated.

- users registered via FrontendUser module will not trigger emails!

Not surprising - EmailNewUser is not autoload outside of the admin interface - see the instructions for using via the API where it mentions that you need to manually load it first. You could either change:

"autoload": "template=admin",

in the EmailNewUser.info.json to autoload : true or you would need to hack the FrontendUser module so that it loads this module with:

wire('modules')->get("EmailNewUser"); // call the module since it is not autoload on the front end

Perhaps you could request for pwFoo to add a check if this module is installed and if so, load it - others might find that useful too.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks! Setting autoload to true actually didn't work, but it is simply enough for me to put this in my register.php:

$modules->get('EmailAdminNewUser');

Now I will get admin emails for users that have registered!

  • Like 2

Share this post


Link to post
Share on other sites

Dont really wortk for me with the FrontendUser Module 

<?php include('./_head.inc'); // include header markup 
$modules->get('EmailAdminNewUser'); // lade Modul um den Admin zu benachrichtigen 
?>
<div class='container paddingtop100'>
  <div class='row'>
            <div class='col-md-4'></div>
            <div class='col-md-4'><img class='img-responsive' src='../site/assets/files/1/pluco-logo.jpg'/></div>
            <div class='col-md-4'></div>
        </div> 
  </div>
<section  class="contain nav-link ">
    
<div  class="register weissbg">
<div class="small text-center" ><?=$page->body_m ?></div>
<div class='container '>
<div class='row'>
<?php 
$fu = $modules->get('FrontendUser');
// prepare login form (default parameters)
$fu->login();
// Default parameter
//$fu->login(array('username', 'password'));
    echo "<h4>Registrierte Nutzer hier anmelden</h4>";
// Additional LoginPersist and ProcessForgotPassword module integration (built-in)
$fu->login(array('username', 'password',  'forgot'));
// process login / form submit
$fu->process('../objekte/');
// output form
echo $fu->render();
 ?>
<?php 
    echo "<br /><h4>Nutzerregistrierung</h4>";

$u_vorname = $modules->get('InputfieldText');
$u_vorname->label = $this->_('Vorname*');
$u_vorname->attr('id+name', 'u_vorname');
$u_vorname->required = 1;
$u_vorname->fhSanitizer = 'text';
$nachname = $modules->get('InputfieldText');
$nachname->label = $this->_('Nachname*');
$nachname->attr('id+name', 'nachname');
$nachname->required = 1;
$nachname->fhSanitizer = 'text';
$unternehmen = $modules->get('InputfieldText');
$unternehmen->label = $this->_('Unternehmen*');
$unternehmen->attr('id+name', 'unternehmen');
$unternehmen->required = 1;
$unternehmen->fhSanitizer = 'text';
$strnr = $modules->get('InputfieldText');
$strnr->label = $this->_('Strasse / Hausnummer*');
$strnr->attr('id+name', 'strnr');
$strnr->required = 1;
$strnr->fhSanitizer = 'text';
$plz = $modules->get('InputfieldText');
$plz->label = $this->_('Plz / Ort*');
$plz->attr('id+name', 'plz');
$plz->required = 1;
$plz->fhSanitizer = 'text';
$tel = $modules->get('InputfieldText');
$tel->label = $this->_('Telefonnummer*');
$tel->attr('id+name', 'tel');
$tel->required = 1;
$tel->fhSanitizer = 'text';

$fu->addHookBefore('save', function($event) {
    $form = wire('fu')->form;
    $user = wire('fu')->userObj;
    $user->addRole('registered');
    if(!count($form->getErrors())) {

        wire('fu')->userObj->u_vorname = $form->fhValue('u_vorname', 'text');
        wire('fu')->userObj->u_nachname = $form->fhValue('nachname', 'text');
        wire('fu')->userObj->u_unternehmen = $form->fhValue('unternehmen', 'text');
        wire('fu')->userObj->u_hausnummer = $form->fhValue('strnr', 'text');
        wire('fu')->userObj->u_plzort = $form->fhValue('plz', 'text');
        wire('fu')->userObj->u_telefonnummer = $form->fhValue('tel', 'text');
 
    }
});
// Call hook after field is processed by PW form api
// prepare register form
$fu->register();
// Default parameter
//$fu->register(array('username', 'email', 'password'));
// Additional email pre-register validation plugin (built-in)
$fu->register(array('username',  $u_vorname, $nachname, $unternehmen , $strnr, $plz, $tel, 'email', 'password'));
// process register / form submit
$fu->process('../registrieren/aktivation/');
// output register form
echo $fu->render();
echo "<p class='small description'>* Gekennzeichnete Felder sind Pflichtangaben<br />Nach der Freischaltung erhalten Sie umgehend eine Bestätigungs-Email mit Ihren Login-Daten.</p>";
?>
</div>
</div>
</div>
</section>
  
<?php include('./_foot.inc'); // include footer markup ?>

whats the mistake here ? 

Share this post


Link to post
Share on other sites

@iNoize,

Looking at your code, you are loading: EmailAdminNewUser rather than EmailNewUser. So, you are not using this module at all, but rather a module written by @Beluga - https://processwire.com/talk/topic/9811-frontenduser-login-logout-and-register-users-members/?p=101533

So I am afraid you will need to ask him about it.

Share this post


Link to post
Share on other sites

Hi, I'm consistently getting the error: 

 No email was sent to the new user because of an unknown problem. Please try the 'Re-send Welcome Message' option.

I'm assuming this is a server configuration problem, does anyone have any idea how to go about rectifying/troubleshooting this?

EDIT: Really strange, if I hardcode the 'from' email address into line 141 instead of using the passed variable (which as far as I can see is exactly the same) it works correctly.

Share this post


Link to post
Share on other sites

Hi @ZGD and welcome to the forums!

Sorry you are having troubles with this module. It does sound like a very weird situation indeed.

Can you please confirm that the from email address is correctly filled out in the module config settings, like so:

post-985-0-10727300-1441374057_thumb.png

If it is, could you try an:

error_log($this->data['fromEmail']);

just after line 141 and see what it returns.

Share this post


Link to post
Share on other sites

Very strange indeed, I'd checked it multiple times, but copy pasting the email address back into the same input seems to have fixed it. I have no idea what happened there, but thanks for suggesting to check it once again.

I have one other question regarding using this in conjunction with Ryan's Import Pages from CSV module. I have a test CSV with 4 columns (title,displayname,email,roles) and 5 rows. I'm trying to import multiple users and have EmailNewUser auto-generate a password for each, it works successfully for the first user/row, but then I get the error "No email was sent to the new user because either their email address or password was not set." after that, I'm assuming because of line 137 (although I'm not sure if it's because of the email or password being blank? Has anyone successfully managed to do this?

EDIT: Seems if I include the 'pass' column, and use "" as the value for each row, it works!

  • Like 1

Share this post


Link to post
Share on other sites

Great - glad to hear you got everything working. 

I am super busy here at the moment and don't have time right now to see if there would be a simple way to remove the need for a blank "pass" column in the CSV field, but I don't think it matters so long as anyone attempting this knows it is required.

Share this post


Link to post
Share on other sites

Thanks adrian, the users have very restricted access to non-sensitive information for this one, it's more of a formality really. I will definitely be using ForcePasswordChange for future projects though, super easy to manage users through PW with these kinds of modules.

  • Like 1

Share this post


Link to post
Share on other sites

I changed my host to a dedicated server. I installed Postfix. Sending test email from module settings does not work.

It works (I receive email), if I replace the "wireMail(wire.." line with:

$mail = wireMail();
$mail->to('somemail@somesite.com')->from('myemail@site.com');
$mail->subject('Mail Subject');
$mail->body('Mail Body');
$mail->bodyHTML('<html><body><h1>Mail Body</h1></body></html>');
$mail->send();

How can I troubleshoot this? With Tracy debugger? :)

Share this post


Link to post
Share on other sites

Hi @Beluga,

Firstly, is it only the test send that isn't working, or do they also fail when adding a new user?

Well I don't think there should be a reason why the syntax you changed it to should work while the:

wireMail('user@domain.com', 'ryan@runs.pw', 'Mail Subject', 'Mail Body'); 

syntax won't.

I think the most likely problem is that I had an incorrect static call to a non-static method in there when doing the test send. Maybe your new server is failing on strict errors? I have fixed this in the latest version. Please let me know if that fixes it for you.

If it doesn't then you could play with Tracy like this and make sure they all return what is expected.

        // send test email if requested
        if (wire('input')->post->test) {
            bd(wire('user')->email, 'Admin User Email');
            bd($data['fromEmail'], 'From Email');
            bd($data['subject'], 'Subject'); // not really relevant, but may as well confirm its value
            bd(EmailNewUser::parseBody($data['body'], $data['fromEmail'], wire('user'), 'password'), 'Body'); // again, not really relevant
            wireMail(wire('user')->email, $data['fromEmail'], $data['subject'], self::parseBody($data['body'], $data['fromEmail'], wire('user'), 'password'));
        }
You will of course have to enable the Tracy debug bar for the backend.

Share this post


Link to post
Share on other sites

I use manual sending of the welcome email. I tested it and it does not work either. I used your bd() and the contents dumped look fine, my email is there etc.

I realized it is a general problem so I posted to the WireMail thread.

  • Like 1

Share this post


Link to post
Share on other sites
On 7/20/2015 at 4:28 PM, Beluga said:

Thanks! Setting autoload to true actually didn't work, but it is simply enough for me to put this in my register.php:


$modules->get('EmailAdminNewUser');

Now I will get admin emails for users that have registered!

Thanks for this @Beluga I had to use 

$modules->get('EmailNewUser');

in my register.php instead. But it works with the FrontendUser now. Very useful module @adrian!

  • Like 3

Share this post


Link to post
Share on other sites

I am also getting:

Session: No email was sent to the new user because of an unknown problem. Please try the 'Re-send Welcome Message' option.

PW 2.7.2

Share this post


Link to post
Share on other sites
1 hour ago, benbyf said:

I am also getting:

Session: No email was sent to the new user because of an unknown problem. Please try the 'Re-send Welcome Message' option.

PW 2.7.2

Are you using this with the frontend user module? Are you adding the user via the API or admin? Is the test send working ok?

Share this post


Link to post
Share on other sites

I didn't try the test as it wasnt obvious. I installed, added the settings, then went and created a user in the admin and got the error a couple of times (even when hard coding the email in the module as suggested above).

Share this post


Link to post
Share on other sites
9 minutes ago, benbyf said:

I didn't try the test as it wasnt obvious. I installed, added the settings, then went and created a user in the admin and got the error a couple of times (even when hard coding the email in the module as suggested above).

I am going to need more to go on here. I have been using this module on all my sites (on several different PW versions) since I created it. I don't suppose you could give me access to the server to take a look?

  • Like 1

Share this post


Link to post
Share on other sites

Really sorry but its a clients site not my own personal project. I cant seem to send out through wiremail() so that might be the issue. php mail() works fine.

Share this post


Link to post
Share on other sites
2 minutes ago, benbyf said:

Really sorry but its a clients site not my own personal project.

No problem - understood!

2 minutes ago, benbyf said:

I cant seem to send out through wiremail() so that might be the issue. php mail() works fine.

Do we agree then that it's not an issue with this module, but rather with the setup in your wireMail sending module?

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By apeisa
      Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.
      ***
      Latest screencast: http://www.screencas...73-ab3ba1fea30c
      Grab the code: https://github.com/teppokoivula/AdminBar
      ***
      I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.
      I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4
      When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.
      I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.
      ***
      When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:
      if($this->redirectUrl) $this->session->redirect($this->redirectUrl); if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE else $this->session->redirect("./?id={$this->page->id}");   and...
      if(!empty($_GET['modal'])) { $form->attr('action', './?id=' . $this->id . '&modal=true'); } else { $form->attr('action', './?id=' . $this->id); // OLD LINE }  
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
    • By nbcommunication
      I've spent the last while experimenting with srcset implementation - and PageimageSrcset is the result:
      PageimageSrcset
      Provides configurable srcset and sizes properties/methods for Pageimage.
      Overview
      The main purpose of this module is to make srcset implementation as simple as possible in your template code. It does not handle images rendered in CKEditor or similar fields.
      For an introduction to srcset and sizes, please read this Mozilla article about responsive images.
      Pageimage::srcset()
      // The property, which uses the set rules in the module configuration $srcset = $image->srcset; // A method call, using a set rules string // Delimiting with a newline (\n) would also work, but not as readable $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x"); // The same as above but using an indexed/sequential array $srcset = $image->srcset([ "320", "480", "640x480 768w", "1240", "2048 2x", ]); // The same as above but using an associative array // No rule checking is performed $srcset = $image->srcset([ "320w" => [320], "480w" => [480], "768w" => [640, 480], "1240w" => [1240], "2x" => [2048], ]); // Use the default set rules with portrait images generated for mobile/tablet devices $srcset = $image->srcset(true); // Return the srcset using all arguments $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x", [ "portrait" => "320, 640", ]); // The set rules above are a demonstration, not a recommendation! Image variations are only created for set rules which require a smaller image than the Pageimage itself. On large sites this may still result in a lot of images being generated. If you have limited storage, please use this module wisely.
      Portrait Mode
      In many situations, the ratio of the image does not need to change at different screen sizes. However, images that cover the entire viewport are an exception to this and are often the ones that benefit most from srcset implementation.
      The main problem with cover images is that they need to display landscape on desktop devices and portrait when this orientation is used on mobile and tablet devices.
      You can automatically generate portrait images by enabling portrait mode. It is recommended that you use this in combination with Pageimage::focus() so that the portrait variations retain the correct subject.
      The generated variations are HiDPI/Retina versions. Their height is determined by the portrait ratio (e.g. 9:16). Variations are always generated, regardless of whether the original image is smaller. Upscaling is disabled though, so you may find that some variations are actually smaller than they say they are in their filename.
      The sizes attribute should be used when portrait mode is enabled. Pageimage::sizes will return (orientation: portrait) and (max-width: {maxWidth}px) 50vw by default, which handles the use of these images for retina devices. The maximum width used in this rule is the largest set width.
      Pageimage::sizes()
      There is no option to configure default sizes because in most cases 100vw is all you need, and you do not need to output this anyway as it is inferred when using the srcset attribute. You can use the method for custom sizes though:
      // The property $sizes = $image->sizes; // Returns 100vw in most cases // Returns '(orientation: portrait) and (max-width: {maxWidth}px)50vw' if portrait mode enabled // A method call, using a mixture of integer widths and media query rules // Integer widths are treated as a min-width media query rule $sizes = $image->sizes([ 480 => 50, "(orientation: portrait) and (max-width: 640px)" => 100, 960 => 25, ]); // (min-width: 480px) 50vw, (orientation: portrait) and (max-width: 640px) 100vw, (min-width: 960px) 25vw // Determine widths by UIkit 'child-width' classes $sizes = $image->sizes([ "uk-child-width-1-2@s", "uk-child-width-1-3@l", ]); // (min-width: 640px) 50vw, (min-width: 1200px) 33.33vw // Determine widths by UIkit 'width' classes $sizes = $image->sizes([ "uk-width-1-2@m", "uk-width-1-3@xl", ]); // (min-width: 960px) 50vw, (min-width: 1600px) 33.33vw // Return the portrait size rule $sizes = $image->sizes(true); // (orientation: portrait) and (max-width: {maxWidth}px) 50vw // The arguments above are a demonstration, not a recommendation! Pageimage::render()
      This module extends the options available to this method with:
      srcset: When the module is installed, this will always be added, unless set to false. Any values in the formats described above can be passed. sizes: Only used if specified. Any values in the formats described above can be passed. uk-img: If passed, as either true or as a valid uk-img value, then this attribute will be added. The srcset attribute will also become data-srcset. Please refer to the API Reference for more information about this method.
      // Render an image using the default set rules echo $image->render(); // <img src='image.jpg' alt='' srcset='{default set rules}'> // Render an image using custom set rules echo $image->render(["srcset" => "480, 1240x640"]); // <img src='image.jpg' alt='' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w'> // Render an image using custom set rules and sizes // Also use the `markup` argument echo $image->render("<img class='image' src='{url}' alt='Image'>", [ "srcset" => "480, 1240", "sizes" => [1240 => 50], ]); // <img class='image' src='image.jpg' alt='Image' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 1240px) 50vw'> // Render an image using custom set rules and sizes // Enable uk-img echo $image->render([ "srcset" => "480, 1240", "sizes" => ["uk-child-width-1-2@m"], "uk-img" => true, ]); // <img src='image.jpg' alt='' data-uk-img data-srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 960px) 50vw'> // Render an image using portrait mode // Default rule sets used: 320, 640, 768, 1024, 1366, 1600 // Portrait widths used: 320, 640, 768 // Original image is 1000px wide // Not possible to use portrait mode and custom sets or portrait widths in render() // Sizes attribute automatically added echo $image->render(["srcset" => true]); // <img src='image.jpg' alt='' srcset='image.320x569-srcset-hidpi.jpg 320w, image.640x1138-srcset-hidpi.jpg 640w, image.768x1365-srcset-hidpi.jpg 768w, image.jpg 1024w' sizes='(orientation: portrait) and (max-width: 768px) 50vw'> Configuration
      To configure this module, go to Modules > Configure > PageimageSrcset.
      Set Rules
      These are the default set rules that will be used when none are specified, e.g. when calling the property: $image->srcset.
      Each set rule should be entered on a new line, in the format {width}x{height} {inherentwidth}w|{resolution}x.
      Not all arguments are required - you will probably find that specifying the width is sufficient for most cases. Here's a few examples of valid set rules and the sets they generate:
      Set Rule Set Generated Arguments Used 320 image.320x0-srcset.jpg 320w {width} 480x540 image.480x540-srcset.jpg 480w {width}x{height} 640x480 768w image.640x480-srcset.jpg 768w {width}x{height} {inherentwidth}w 2048 2x image.2048x0-srcset.jpg 2x {width} {resolution}x How you configure your rules is dependent on the needs of the site you are developing; there are no prescriptive rules that will meet the needs of most situations. This article gives a good overview of some of the things to consider.
      When you save your rules, a preview of the sets generated and an equivalent method call will be displayed to the right. Invalid rules will not be used, and you will be notified of this.
      Portrait Mode
      Set Widths
      A comma limited list of widths to create HiDPI/Retina portrait variations for.
      Crop Ratio
      The portrait ratio that should be used to crop the image. The default of 9:16 should be fine for most circumstances as this is the standard portrait ratio of most devices. However, you can specify something different if you want. If you add a landscape ratio, it will be switched to portrait when used.
      Any crops in the set rules ({width}x{height}) are ignored for portrait mode variations as this ratio is used instead.
      UIkit Widths
      If your website theme uses UIkit, you can pass an array of UIkit width classes to Pageimage::sizes to be converted to sizes. The values stored here are used to do this. If you have customised the breakpoints on your theme, you should also customise them here.
      Please note that only 1- widths are evaluated by Pageimage::sizes, e.g. uk-width-2-3 will not work.
      Remove Variations
      If checked, the image variations generated by this module are cleared on Submit. On large sites, this may take a while. It makes sense to run this after you have made changes to the set rules.
      Image Suffix
      You will see this field when Remove Variations is checked. The value is appended to the name of the images generated by this module and is used to identify variations. You should not encounter any issues with the default suffix, but if you find that it conflicts with any other functionality on your site, you can set a custom suffix instead.
      Debug Mode
      When this is enabled, a range of information is logged to pageimage-srcset.
      PageimageSrcsetDebug.js is also added to the <head> of your HTML pages. This will console.log a range of information about the images and nodes using srcset on your page after a window.onresize event is triggered. This can assist you in debugging your implementation.
      The browser will always use the highest resolution image it has loaded or has cached. You may need to disable browser caching to determine whether your set rules are working, and it makes sense to work from a small screen size and up. If you do it the other way, the browser is going to continue to use the higher resolution image it loaded first.
      UIkit Features
      This module implements some additional features that are tailored towards UIkit being used as the front-end theme framework, but this is not required to use the module.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. ProcessWire >= 3.0.123 is required to use this module.
×
×
  • Create New...