function user_relationship_privatemsg_privatemsg_recipient_type_info in User Relationships 7

Implements hook_privatemsg_recipient_types_info().

File

user_relationship_privatemsg/user_relationship_privatemsg.module, line 34

Allows to send messages to all members of a role.

Code

function user_relationship_privatemsg_privatemsg_recipient_type_info() {
  $types = user_relationships_types_load();

  // If there is no relationship defined, don't expose it as a recipient type.
  if (empty($types)) {
    return;
  }
  return array(
    'user_relationship' => array(
      'name' => t('User relationship'),
      'description' => t('Enter the name of a user relationship to write a message to all related users. Example: %example.', array(
        '%example' => reset($types)->plural_name,
      )),
      'format' => 'user_relationship_privatemsg_format',
      'load' => 'user_relationship_privatemsg_load_multiple',
      'autocomplete' => 'user_relationship_privatemsg_autocomplete',
      'generate recipients' => 'user_relationship_privatemsg_load_recipients',
      'count' => 'user_relationship_privatemsg_count_recipients',
      'write callback' => 'user_relationship_privatemsg_check_write_access',
      'view access' => 'view relationship recipients',
    ),
  );
}