user_relationships_ui.api.php in User Relationships 7

Hook documentation for User Relationships UI.

File

user_relationships_ui/user_relationships_ui.api.php

<?php

/**
 * @file
 * Hook documentation for User Relationships UI.
 */

/**
 * Alter the table header definition of relationship listings.
 *
 * @param $header
 *   Array with the table header definition.
 * @param $edit_access
 *   TRUE if the current user has edit access.
 *
 * @see user_relationships_ui_get_table_header()
 */
function hook_user_relationships_ui_table_header_alter(&$header, $edit_access) {
  $insert_index = array_search(t('Relationship'), $header) + 1;
  $header = array_merge(array_slice($header, 0, $insert_index), array(
    t('Comments'),
  ), array_slice($header, $insert_index));
}

/**
 * Alter the table rows of relationship listings.
 *
 * @param $row
 *   Array with the table row content.
 * @param $relationship
 *   Relationship object.
 * @param $account
 *   User account for which the relationships are shown.
 *
 * @see user_relationships_ui_get_table_row()
 */
function user_relationship_elaborations_user_relationships_ui_table_row_alter(&$row, $relationship, $account) {
  $insert_index = variable_get('user_relationships_show_user_pictures', 0) + 2;
  $row = array_merge(array_slice($row, 0, $insert_index), array(
    $relationship->elaboration,
  ), array_slice($row, $insert_index));
}

Functions

Name	Description
hook_user_relationships_ui_table_header_alter	Alter the table header definition of relationship listings.
user_relationship_elaborations_user_relationships_ui_table_row_alter	Alter the table rows of relationship listings.