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

Parameters

$textstring

the comment text

$charstringoptional

character to denote a special PO comment, like :, default is a spaceDefault: ' '

Uses · 1

• PO::prepend_each_line()Inserts $with in the beginning of every new line of $input_string and returns the modified string

Used by · 1

• PO::export_entry()Builds a string from the entry for inclusion in PO file

Source

View on Trac ↗View on GitHub ↗

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

History

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/pomo/po.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.