Comment::getFormattedCommentText() method

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.


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

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


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


Comment methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #528
    In the 528th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called Icons Filter, and more. Read on! / 22 June 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull