Add webform submission hook

Patch attached. Pretty simple...

To use the hook, you will need to create an instance of hook_webform_submission where hook is replaced with the name of your module. So for example in my testing I used a module named test that consisted of two files living in a folder named test in the modules directory. Those files were:

test/test.info

name = test
description = "Module for testing webform hook"
package = Administration

test/test.module

<?php
  function test_webform_submission( $submission ) {
    $url = "https://www.example.com/public/register";
    $query = "s=stlawevr&NAME_FIRST=${submission['firstname']}";
    drupal_goto($url, $query);
  }

That's it. Once the module is enabled on the admin pages, all submissions will run this function after emails are sent and submission is logged. Clearly this is a proof of concept - real hook might want to do a conditional redirect. Note that I use drupal_goto instead of php's header function call to do the redirection. Check out the api reference - it handles some niceties so you don't have to.

In theory you could create the hook function within the webform module, but I wouldn't recommend it just to simplify upgrading in the future.

From my perspective hooks are a better way to implement the post processing options - perhaps even for the additional processing functionality that currently exists. To my way of thinking, exposing a field that will except and process php code to site maintainers or the public is pretty risky. By using hooks you can relegate the functionality to the site developers.

Hope it's in the next release... Thanks for the module.

That's a good question & I hadn't considered it. Offhand I would say the patch I wrote makes more sense, since it is not the form that I want to mess with per se or the values, I only want to do a redirect after your great module is finished with it. I believe it requires a bit of hacking the Drupal DB in order to alter the order that module hooks are called, but it is possible. And it would be important to ensure your module has sent any emails and recorded the submission in the DB before any redirect occurs, so the order would be important.

It doesn't seem unusual to me to have a module create it's own hooks & it is only one additional line of code. Many of the bug requests I've seen skirt around this issue of how to extend the functionality of the webform without breaking the email or db logging, so I think it will be used. I agree that if it was general processing of the form values, or something that didn't involve the functioning of the webform module, it would make more sense to use the core hooks. But since I want to only alter the lest step of your process, this seems like the simplest way to do it.

That's my 2 cents - thanks again.

Great - could you explain how you would do it?

So after some more investigation I've figured it out & indeed the patch is unneeded. It's simpler than I thought to just use the hook_form_alter as quicksketch had recommended, though there are some differences from his example in #2. For one thing, I didn't want to do anything complicated, just to redirect the form once the webform was finished.

As before you need to add this to a module or create a new module. This is only the code from the mymodule.module file - use the example above for the .info file if needed.

  function mymodule_form_alter($form_id, &$form) {
    if ($form['#base'] == 'webform_client_form' && $form['#post']['op'] == 'Submit') {
      $url = "https://www.example.com/public/register";
      if ($form['#post']['submitted']['email'] ) {
        $query = "EMAIL=". $form['#post']['submitted']['email'] ;
      }
      if ($form['#post']['submitted']['firstName'] ) {
        $query .= "&NAME_FIRST=". $form['#post']['submitted']['firstName'] ;
      }
      if ($form['#post']['submitted']['lastName'] ) {
        $query .= "&NAME_LAST=". $form['#post']['submitted']['lastName'] ;
      }
      $form['#redirect'] = "$url?$query";
    }
  }

Some things to notice...

• unless you only want to apply this to a specific form, you need to check $form['#base'] == 'webform_client_form' not $form_id since it contains the id # appended to the end of 'webform_client_form'
• I opted to access the fields & values via the $form['#post'] array because it is the simplest to extract field names & values from
• To do the redirect, just set $form['#redirect'] to the new url, get query included (if applicable)

That's all.