7 comment.api.php hook_comment_view_alter(&$build)

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.

Parameters

$build: A renderable array representing the comment.

See also

comment_view()

hook_entity_view_alter()

Related topics

1 invocation of hook_comment_view_alter()
comment_view in modules/comment/comment.module
Generate an array for rendering the given comment.

File

modules/comment/comment.api.php, line 96
Hooks provided by the Comment module.

Code

function hook_comment_view_alter(&$build) {
  // Check for the existence of a field added by another module.
  if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
    // 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';
}