function user_relationships_ui_get_message in User Relationships 5.3

Same name and namespace in other branches

1. 6 user_relationships_ui/user_relationships_ui.module \user_relationships_ui_get_message()

Public API for getting the set or default message

Use the relationship message system. This is set up to retrieve the admin's set messages or fall back on the default if those aren't set. It'll automatically replace specific tokens with information from $relationship. If you need to provide additional tokens, they can be sent through $replacements.

Parameters

$key: string message name Check at the top of user_relationships_ui.module in "_user_relationships_ui_default_messages()" for the keys and default messages attached to those keys.

$replacements: array replaceable tokens to append or replace default tokens

Return value

string formatted message

7 calls to user_relationships_ui_get_message()

user_relationships_ui_pending_requested_submit in user_relationships_ui/user_relationships_ui.actions.inc

Approve, Disapprove, or Cancel a relationship request

user_relationships_ui_remove_submit in user_relationships_ui/user_relationships_ui.actions.inc

Remove a relationship

user_relationships_ui_request in user_relationships_ui/user_relationships_ui.forms.inc

Request a new relationship with another user

user_relationships_ui_request_form_validate in user_relationships_ui/user_relationships_ui.actions.inc

Validate relationship request.

user_relationships_ui_request_submit in user_relationships_ui/user_relationships_ui.actions.inc

Process relationship request.

... See full list

File

user_relationships_ui/user_relationships_ui.module, line 29

Code

function user_relationships_ui_get_message($key, $relationship = NULL, $replacements = array()) {
  $msg = variable_get("user_relationships_ui_msg_{$key}", NULL);
  if (is_null($msg)) {
    $messages = _user_relationships_ui_default_messages();
    $msg = _user_relationships_get_from_array($key, $messages);
  }
  if ($relationship) {
    if (!$relationship->requester) {
      $relationship->requester = user_load($relationship->requester_id);
    }
    if (!$relationship->requestee) {
      $relationship->requestee = user_load($relationship->requestee_id);
    }
    if (!($relationship->name || $relationship->type)) {
      $relationship->type = user_relationships_type_load($relationship->rtid);
    }
    $replaceables = array(
      '!requester' => theme('username', $relationship->requester),
      '!requestee' => theme('username', $relationship->requestee),
      '%relationship_name' => $relationship->name ? $relationship->name : $relationship->type->name,
      '%relationship_plural_name' => $relationship->plural_name ? $relationship->plural_name : $relationship->type->plural_name,
    );
    $replacements = array_merge($replaceables, $replacements);
  }
  return t($msg, $replacements);
}