function webform_confirm_email_help in Webform Confirm Email Address 6

Same name and namespace in other branches

1. 6.2 webform_confirm_email.module \webform_confirm_email_help()
2. 7.2 webform_confirm_email.module \webform_confirm_email_help()
3. 7 webform_confirm_email.module \webform_confirm_email_help()

Provide online user help.

Parameters

$path: The router menu path, as defined in hook_menu(), for the help that is being requested; e.g., 'admin/node' or 'user/edit'. If the router path includes a % wildcard, then this will appear in $path; for example, node pages would have $path equal to 'node/%' or 'node/%/view'. Your hook implementation may also be called with special descriptors after a "#" sign. Some examples:

• admin/help#modulename The main module help text, displayed on the admin/help/modulename page and linked to from the admin/help page.
• user/help#modulename The help for a distributed authorization module (if applicable).

$arg: An array that corresponds to the return value of the arg() function, for modules that want to provide help that is specific to certain values of wildcards in $path. For example, you could provide help for the path 'user/1' by looking for the path 'user/%' and $arg[1] == '1'. This array should always be used rather than directly invoking arg(), because your hook implementation may be called for other purposes besides building the current page's help. Note that depending on which module is invoking hook_help, $arg may contain only empty strings. Regardless, $arg[0] to $arg[11] will always be set.

Return value

A localized string containing the help text.

File

./webform_confirm_email.module, line 285

Add email confirmation rules to webforms used as letter campaigns

Code

function webform_confirm_email_help($path, $arg) {
  switch ($path) {
    case 'admin/help#webform_confirm_email':
      return '<p>' . t('This addon module for Webform let\'s you specify which, if any, email addresses should be confirmed by their owner before a webform is sent. Mostly used for email campaigns.') . '</p>';
    default:
      return '';
  }
}