modules/user_titles/API.txt


User Titles defines a hook function other modules can define. It is:

hook_user_titles($op, $uid = null)
  Use this function to describe what point scheme your module defines
  for User Titles.

  $op: The operation to be acted upon
    'register'
      Return module name so that module can be called later

    'name'
      Return translated pretty module name for display
      Example:
        return t('Dollars donated');

    'description'
      Return translated description for module's point scheme
      Example:
        return t('Points based on dollars donated');

    'units'
      Return short, capitalized name of what these points are.
      Example:
        return t('Dollars');

    'url'
      Drupal menu path to module's help or admin page to be displayed.
      Example:
        return "admin/help/donate";

    'get'
      Return number of points for $uid

1
2	User Titles defines a hook function other modules can define. It is:
3
4	hook_user_titles($op, $uid = null)
5	Use this function to describe what point scheme your module defines
6	for User Titles.
7
8	$op: The operation to be acted upon
9	'register'
10	Return module name so that module can be called later
11
12	'name'
13	Return translated pretty module name for display
14	Example:
15	return t('Dollars donated');
16
17	'description'
18	Return translated description for module's point scheme
19	Example:
20	return t('Points based on dollars donated');
21
22	'units'
23	Return short, capitalized name of what these points are.
24	Example:
25	return t('Dollars');
26
27	'url'
28	Drupal menu path to module's help or admin page to be displayed.
29	Example:
30	return "admin/help/donate";
31
32	'get'
33	Return number of points for $uid
34