Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.
PO::comment_block( string $text, string $char = ' ' )
Prepare a text as a comment — wraps the lines and prepends # and a special character to each line
Parameters
-
$textstring Required -
the comment text
-
$charstring Optional -
character to denote a special PO comment, like :, default is a space
Default:
' '
Source
File: wp-includes/pomo/po.php.
View all references
public static function comment_block( $text, $char = ' ' ) {
$text = wordwrap( $text, PO_MAX_LINE_LEN - 3 );
return PO::prepend_each_line( $text, "#$char " );
}