function rules_action_callback_help in Rules 6

The configuration help callback for an action.

It should be placed into the file MODULENAME.rules_forms.inc or into MODULENAME.rules.inc.

Any help text returned by this callback is shown during the action configuration.

Return value

The translated string to show.

See also

hook_rules_action_info()

Related topics

File

rules/rules.api.php, line 254

This file contains no working PHP code; it exists to provide additional documentation for doxygen as well as to document hooks in the standard Drupal manner.

Code

function rules_action_callback_help() {
  return t('This help text is going to be displayed during action configuration.');
}