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

Latest news

  • ProcessWire Weekly #547
    In the 547th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new modules, and more. Read on!
    Weekly.pw / 2 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani