PO::comment_block

Advertisement

Private Access Private Access

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.

Summery Summery

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

Syntax Syntax

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

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

File: wp-includes/pomo/po.php

		 *  like :, default is a space
		 */
		public static function comment_block( $text, $char = ' ' ) {
			$text = wordwrap( $text, PO_MAX_LINE_LEN - 3 );

Advertisement

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.