PO::prepend_each_line( string $input_string, string $with )
- Source
wp-includes/pomo/po.php:177
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
$input_stringstring- prepend lines in this string
$withstring- prepend lines with this string
Performance profile
How much work a call to PO::prepend_each_line() 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
- Light
- Scaling
- Scales with input
- Instructions
- 17–27
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 30.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost PO::prepend_each_line() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 17–18 | explode() |
| always | 22–23 | explode(), end() |
| always | 26–27 | explode(), end(), array_pop() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 30 | 17–27 | 4 | |
| 8.5 | 30 | 17–27 | 4 | |
| 8.4 | 30 | 17–27 | 4 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 36 | 23–33 | 4 | |
| 8.2 | 36 | 23–33 | 4 | |
| 8.1 | 36 | 23–33 | 4 | |
| 7.4 | 36 | 23–33 | 4 |
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.
Used by · 2
- PO::comment_block()Prepare a text as a comment -- wraps the lines and prepends # and a special character to each line
- PO::export_headers()Exports headers to a PO entry
Source code
public static function prepend_each_line( $input_string, $with ) { $lines = explode( "\n", $input_string ); $append = ''; if ( "\n" === substr( $input_string, -1 ) && '' === end( $lines ) ) { /* * Last line might be empty because $input_string was terminated * with a newline, remove it from the $lines array, * we'll restore state by re-terminating the string at the end. */ array_pop( $lines ); $append = "\n"; } foreach ( $lines as &$line ) { $line = $with . $line; } unset( $line ); return implode( "\n", $lines ) . $append; }Changelog
Unchanged from 6.7.7 through 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.