Comment::getFormattedCommentText()

Get comment text as formatted string

Note that the default options behavior is to return comment text with paragraphs split by </p><p> but without the first <p> and last </p> since it is assumed these will be the markup you wrap the comment in. If you want it to include the wrapping <p>…</p> tags then specify true for the wrapParagraph option in the $options argument.

Available since version 3.0.169.

Usage

// basic usage
$string = $comment->getFormattedCommentText();

// usage with all arguments
$string = $comment->getFormattedCommentText(array $options = []);

Arguments

NameType(s)Description
$options (optional)array
  • useParagraphs (bool): Convert newlines to paragraphs? Default:true
  • wrapParagraph (bool): Use wrapping

    …

    tags around return value? Default:false
  • useLinebreaks (bool): Convert single newlines to
    tags? Default:true

Return value

string

Comment methods and properties

API reference based on ProcessWire core version 3.0.252