function user_relationships_get_message in User Relationships 5.2

Same name and namespace in other branches

1. 5 user_relationships_api.inc \user_relationships_get_message()
2. 7 user_relationships.module \user_relationships_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.module in "user_relationships_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

8 calls to user_relationships_get_message()

user_relationships_pending_requested_submit in ./user_relationships_actions.inc

Approve, Disapprove, or Cancel a relationship request

user_relationships_remove_submit in ./user_relationships_actions.inc

Remove a relationship

user_relationships_request in ./user_relationships_forms.inc

Request a new relationship with another user

user_relationships_request_submit in ./user_relationships_actions.inc

Process relationship request.

user_relationships_request_validate in ./user_relationships_actions.inc

Validate relationship request.

... See full list

File

./user_relationships_api.inc, line 276

Code

function user_relationships_get_message($key, $relationship = NULL, $replacements = array()) {
  $msg = variable_get("user_relationships_msg_{$key}", NULL);
  if (is_null($msg)) {
    $messages = user_relationships_default_messages();
    $msg = _user_relationships_get_from_array($key, $messages);
  }
  if ($relationship) {
    if (!$relationship->requester) {
      $relationship->requester = user_load(array(
        'uid' => $relationship->requester_id,
      ));
    }
    if (!$relationship->requestee) {
      $relationship->requestee = user_load(array(
        'uid' => $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);
}