PO::comment_block │ public static │ WP 1.0

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

Метод класса: PO{}

Внутренняя функция — эта функция рассчитана на использование самим ядром. Не рекомендуется использовать эту функцию в своем коде.

Хуков нет.

Возвращает

null. Ничего (null).

Использование

$result = PO::comment_block( $text, $char );
$text(строка) (обязательный)
the comment text.
$char(строка)
character to denote a special PO comment, like :, default is a space.
По умолчанию: ' '

Код PO::comment_block() WP 6.8.1

wp-includes/pomo/po.php 
public static function comment_block( $text, $char = ' ' ) {
	$text = wordwrap( $text, PO_MAX_LINE_LEN - 3 );
	return PO::prepend_each_line( $text, "#$char " );
}