function customfilter_help in Custom filter 7

Same name and namespace in other branches

1. 5 customfilter.module \customfilter_help()
2. 6 customfilter.module \customfilter_help()
3. 7.2 customfilter.module \customfilter_help()
4. 2.0.x customfilter.module \customfilter_help()

Implements hook_help().

Set the help messages to show to user.

@todo Document the param $arg.

Parameters

string $path: The path where the user is.

$arg:

Return value

string The help message

File

./customfilter.module, line 156

Allows the users with the right permission to define custom filters.

Code

function customfilter_help($path, $arg) {
  $help = '';
  switch ($path) {
    case 'admin/modules#description':
      $help = t('Allows the users with the right permission to create custom filters.');
      break;
    case 'admin/config/content/customfilter':
      $help = '<p>' . t('Custom filter provides the ability for creating user defined filters using regular expressions. Instead of creating filter modules, users can create their own filter for specific site purpose.') . '</p>';
      $help .= '<p>' . t('A filter is a collection of replacement rules. Each filter will appear in the input format settings page. Click on the filter name to see its replacement rules.') . '</p>';
      break;
    case 'admin/config/content/customfilter/%/add':
    case 'admin/config/content/customfilter/%/%':
    case 'admin/config/content/customfilter/%/%/edit':
    case 'admin/config/content/customfilter/%/%/add':
      $help = '<p>' . t('For more information about the regular expressions syntax, see <a href="http://www.php.net/manual/en/regexp.reference.php">Regular expression details</a>.') . '</p>';
      break;
  }
  return $help;
}