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.

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.248

Latest news

  • ProcessWire Weekly #581
    The 581st issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 28 June 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer