ProcessCommentsManager::renderComment()

Render the markup for a single comment

Hookable 3.0.204

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Internal usage

// basic internal usage
$string = $processCommentsManager->renderComment(Comment $comment);

// internal usage with all arguments
$string = $processCommentsManager->renderComment(Comment $comment, array $options = []);

Arguments

NameType(s)Description
$commentComment
$options (optional)array

Options 3.0.204

Return value

string


Hooking ProcessCommentsManager::renderComment(…)

You can add your own hook events that are executed either before or after the ProcessCommentsManager::renderComment(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each ProcessCommentsManager::renderComment(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('ProcessCommentsManager::renderComment', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessCommentsManager = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $comment = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $comment);
  $event->arguments(1, $options);
});

Hooking after

The 'after' hooks are called immediately after each ProcessCommentsManager::renderComment(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ProcessCommentsManager::renderComment', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessCommentsManager = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $comment = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

ProcessCommentsManager methods and properties

API reference based on ProcessWire core version 3.0.253