comment.api.php 4.61 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
<?php

/**
 * @file
 * Hooks provided by the Comment module.
 */

/**
 * @addtogroup hooks
 * @{
 */

13 14 15 16 17 18 19 20 21 22 23 24 25
/**
 * The comment passed validation and is about to be saved.
 *
 * Modules may make changes to the comment before it is saved to the database.
 *
 * @param $comment
 *   The comment object.
 */
function hook_comment_presave($comment) {
  // Remove leading & trailing spaces from the comment subject.
  $comment->subject = trim($comment->subject);
}

26
/**
27
 * The comment is being inserted.
28
 *
29 30
 * @param $comment
 *   The comment object.
31
 */
32
function hook_comment_insert($comment) {
33
  // Reindex the node when comments are added.
34
  search_touch_node($comment->nid);
35 36 37 38 39
}

/**
 * The comment is being updated.
 *
40 41
 * @param $comment
 *   The comment object.
42
 */
43
function hook_comment_update($comment) {
44
  // Reindex the node when comments are updated.
45
  search_touch_node($comment->nid);
46 47
}

48 49 50 51 52 53 54 55 56 57 58 59 60
/**
 * Comments are being loaded from the database.
 *
 * @param $comments
 *  An array of comment objects indexed by cid.
 */
function hook_comment_load($comments) {
  $result = db_query('SELECT cid, foo FROM {mytable} WHERE cid IN (:cids)', array(':cids' => array_keys($comments)));
  foreach ($result as $record) {
    $comments[$record->cid]->foo = $record->foo;
  }
}

61 62 63 64 65
/**
 * The comment is being viewed. This hook can be used to add additional data to the comment before theming.
 *
 * @param $comment
 *   Passes in the comment the action is being performed on.
66 67 68 69
 * @param $view_mode
 *   View mode, e.g. 'full', 'teaser'...
 * @param $langcode
 *   The language code used for rendering.
70 71
 *
 * @see hook_entity_view()
72
 */
73
function hook_comment_view($comment, $view_mode, $langcode) {
74
  // how old is the comment
75
  $comment->time_ago = time() - $comment->changed;
76 77
}

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
/**
 * The comment was built; the module may modify the structured content.
 *
 * This hook is called after the content has been assembled in a structured array
 * and may be used for doing processing which requires that the complete comment
 * content structure has been built.
 *
 * If the module wishes to act on the rendered HTML of the comment rather than the
 * structured content array, it may use this hook to add a #post_render callback.
 * Alternatively, it could also implement hook_preprocess_comment(). See
 * drupal_render() and theme() documentation respectively for details.
 *
 * @param $build
 *   A renderable array representing the comment.
 *
93
 * @see comment_view()
94
 * @see hook_entity_view_alter()
95
 */
96
function hook_comment_view_alter(&$build) {
97
  // Check for the existence of a field added by another module.
98
  if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
99 100 101 102 103 104 105 106
    // Change its weight.
    $build['an_additional_field']['#weight'] = -10;
  }

  // Add a #post_render callback to act on the rendered HTML of the comment.
  $build['#post_render'][] = 'my_module_comment_post_render';
}

107 108 109
/**
 * The comment is being published by the moderator.
 *
110
 * @param $comment
111
 *   Passes in the comment the action is being performed on.
112 113 114
 * @return
 *   Nothing.
 */
115 116
function hook_comment_publish($comment) {
  drupal_set_message(t('Comment: @subject has been published', array('@subject' => $comment->subject)));
117 118 119 120 121 122 123 124 125 126
}

/**
 * The comment is being unpublished by the moderator.
 *
 * @param $comment
 *   Passes in the comment the action is being performed on.
 * @return
 *   Nothing.
 */
127
function hook_comment_unpublish($comment) {
128 129 130 131
  drupal_set_message(t('Comment: @subject has been unpublished', array('@subject' => $comment->subject)));
}

/**
132 133 134 135 136
 * Act before comment deletion.
 *
 * This hook is invoked from comment_delete_multiple() before
 * field_attach_delete() is called and before the comment is actually removed
 * from the database.
137 138
 *
 * @param $comment
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
 *   The comment object for the comment that is about to be deleted.
 *
 * @see hook_comment_delete()
 * @see comment_delete_multiple()
 * @see entity_delete_multiple()
 */
function hook_comment_predelete($comment) {
  // Delete a record associated with the comment in a custom table.
  db_delete('example_comment_table')
    ->condition('cid', $comment->cid)
    ->execute();
}

/**
 * Respond to comment deletion.
 *
 * This hook is invoked from comment_delete_multiple() after
 * field_attach_delete() has called and after the comment has been removed from
 * the database.
 *
 * @param $comment
 *   The comment object for the comment that has been deleted.
 *
 * @see hook_comment_predelete()
 * @see comment_delete_multiple()
 * @see entity_delete_multiple()
165
 */
166
function hook_comment_delete($comment) {
167 168 169
  drupal_set_message(t('Comment: @subject has been deleted', array('@subject' => $comment->subject)));
}

170 171 172
/**
 * @} End of "addtogroup hooks".
 */