W3cubDocs

/WordPress

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 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

Parameters

$text

(string) (Required) the comment text

$char

(string) (Optional) character to denote a special PO comment, like :, default is a space

Default value: ' '

Source

File: 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 " );
		}

Uses

Uses Description
wp-includes/pomo/po.php: PO::prepend_each_line()

Inserts $with in the beginning of every new line of $string and returns the modified string

Used By

Used By Description
wp-includes/pomo/po.php: PO::export_entry()

Builds a string from the entry for inclusion in PO file

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/po/comment_block