wppaste
WordPress

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

Source
wp-includes/pomo/po.php:215
Prepare a text as a comment -- wraps the lines and prepends # and a special character to each line

Compatibility

WordPress
core
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$textstring
the comment text
$charstringoptional
character to denote a special PO comment, like :, default is a spaceDefault: ' '

Performance profile

How much work a call to PO::comment_block() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
17

Executed per call on PHP 8.5. The body compiles to 17.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost PO::comment_block() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always17wordwrap(), ::PO()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 17 instructions, 17 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

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

Source code

View on Trac View on GitHub 

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

Changelog

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