PO::comment_block( string $text, string $char = ‘ ‘ )

In this article

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.

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


the comment text
character to denote a special PO comment, like :, default is a space

Default:' '


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

User Contributed Notes

You must log in before being able to contribute a note or feedback.