WordPress at a glance
function is not described

PO::comment_block() public WP 1.0

Prepare a text as a comment -- wraps the lines and prepends # and a special character to each line

{} It's a method of the class: PO{}

No Hooks.

Return

````. Null. Nothing.

Usage

$result = PO::comment_block( $text, $char );
$text(string) (required)
the comment text
$char(string)
character to denote a special PO comment, like :, default is a space

Code of PO::comment_block() WP 5.7

<?php
public static function comment_block( $text, $char = ' ' ) {
	$text = wordwrap( $text, PO_MAX_LINE_LEN - 3 );
	return PO::prepend_each_line( $text, "#$char " );
}