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

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only by core. It is listed here for completeness.

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

Parameters

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

Source

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

View all references View on Trac View on GitHub

Uses	Description
PO::prepend_each_line()`wp-includes/pomo/po.php`	Inserts $with in the beginning of every new line of $input_string and returns the modified string

Used by	Description
PO::export_entry()`wp-includes/pomo/po.php`	Builds a string from the entry for inclusion in PO file

User Contributed Notes

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

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

In this article

Parameters

Source

Related

User Contributed Notes