function _invite_user_help in Invite 5.2

Display introductory text on user profile overview pages.

Parameters

$section: The section to display help for.

$uid: A user profile id.

1 call to _invite_user_help()

invite_help in ./invite.module

Implementation of hook_help().

File

./invite.module, line 46

Allows your users to send and track invitations to join your site.

Code

function _invite_user_help($section, $uid) {
  switch ($section) {
    case "user/{$uid}/invites":
    case "user/{$uid}/invites/accepted":
      $output = '<p>' . t("The invitations shown on this page have been used to join the site. Clicking on an e-mail address takes you to the user's profile page.");
      break;
    case "user/{$uid}/invites/pending":
      $output = '<p>' . t("The invitations shown on this page haven't been accepted yet.");
      break;
    case "user/{$uid}/invites/expired":
      $output = '<p>' . t('The invitations shown on this page have not been used to register on the site within the expiration period of @count days.', array(
        '@count' => variable_get('invite_expiry', 30),
      ));
      break;
    default:
      return;
  }
  $output .= ' ' . t('The status <em>deleted</em> means the user account has been terminated.') . '</p>';
  if (!user_access('withdraw accepted invitations')) {
    $output .= '<p>' . t("At any time, you may withdraw either pending or expired invitations. Accepted invitations can't be withdrawn and count permanently toward your invitation allotment.") . '</p>';
  }
  return $output;
}