WP_Text_Diff_Renderer_Table::interleave_changed_lines( array $orig, array $final ): array

Compatibility

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

Parameters

$origarray

Lines of the original version of the text.

$finalarray

Lines of the final version of the text.

Return value

array

Array containing results of comparing the original text to the final text.

• $orig_matchesarray

  Associative array of original matches. Index == row number of $orig, value == corresponding row number of that same line in $final or 'x' if there is no corresponding row (indicating it is a deleted line).

• $final_matchesarray

  Associative array of final matches. Index == row number of $final, value == corresponding row number of that same line in $orig or 'x' if there is no corresponding row (indicating it is a new line).

• $orig_rowsarray

  Associative array of interleaved rows of $orig with blanks to keep matches aligned with side-by-side diff of $final. A value >= 0 corresponds to index of $orig. Value < 0 indicates a blank row.

• $final_rowsarray

  Associative array of interleaved rows of $final with blanks to keep matches aligned with side-by-side diff of $orig. A value >= 0 corresponds to index of $final. Value < 0 indicates a blank row.

Performance profile

How much work a call to WP_Text_Diff_Renderer_Table::interleave_changed_lines() 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

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

44–51

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 175.

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 WP_Text_Diff_Renderer_Table::interleave_changed_lines() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• WP_Text_Diff_Renderer_Table::compute_string_distance()Computes a number that is intended to reflect the "distance" between two strings.

Used by · 1

• WP_Text_Diff_Renderer_Table::_changed()Process changed lines to do word-by-word diffs for extra highlighting.

Source code

View on Trac ↗View on GitHub ↗

395	public function interleave_changed_lines( $orig, $final ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.finalFound396 397		// Contains all pairwise string comparisons. Keys are such that this need only be a one dimensional array.398		$matches = array();399		foreach ( array_keys( $orig ) as $o ) {400			foreach ( array_keys( $final ) as $f ) {401				$matches[ "$o,$f" ] = $this->compute_string_distance( $orig[ $o ], $final[ $f ] );402			}403		}404		asort( $matches ); // Order by string distance.405 406		$orig_matches  = array();407		$final_matches = array();408 409		foreach ( $matches as $keys => $difference ) {410			list($o, $f) = explode( ',', $keys );411			$o           = (int) $o;412			$f           = (int) $f;413 414			// Already have better matches for these guys.415			if ( isset( $orig_matches[ $o ] ) && isset( $final_matches[ $f ] ) ) {416				continue;417			}418 419			// First match for these guys. Must be best match.420			if ( ! isset( $orig_matches[ $o ] ) && ! isset( $final_matches[ $f ] ) ) {421				$orig_matches[ $o ]  = $f;422				$final_matches[ $f ] = $o;423				continue;424			}425 426			// Best match of this final is already taken? Must mean this final is a new row.427			if ( isset( $orig_matches[ $o ] ) ) {428				$final_matches[ $f ] = 'x';429			} elseif ( isset( $final_matches[ $f ] ) ) {430				// Best match of this orig is already taken? Must mean this orig is a deleted row.431				$orig_matches[ $o ] = 'x';432			}433		}434 435		// We read the text in this order.436		ksort( $orig_matches );437		ksort( $final_matches );438 439		// Stores rows and blanks for each column.440		$orig_rows      = array_keys( $orig_matches );441		$orig_rows_copy = $orig_rows;442		$final_rows     = array_keys( $final_matches );443 444		/*445		 * Interleaves rows with blanks to keep matches aligned.446		 * We may end up with some extraneous blank rows, but we'll just ignore them later.447		 */448		foreach ( $orig_rows_copy as $orig_row ) {449			$final_pos = array_search( $orig_matches[ $orig_row ], $final_rows, true );450			$orig_pos  = (int) array_search( $orig_row, $orig_rows, true );451 452			if ( false === $final_pos ) { // This orig is paired with a blank final.453				array_splice( $final_rows, $orig_pos, 0, -1 );454			} elseif ( $final_pos < $orig_pos ) { // This orig's match is up a ways. Pad final with blank rows.455				$diff_array = range( -1, $final_pos - $orig_pos );456				array_splice( $final_rows, $orig_pos, 0, $diff_array );457			} elseif ( $final_pos > $orig_pos ) { // This orig's match is down a ways. Pad orig with blank rows.458				$diff_array = range( -1, $orig_pos - $final_pos );459				array_splice( $orig_rows, $orig_pos, 0, $diff_array );460			}461		}462 463		// Pad the ends with blank rows if the columns aren't the same length.464		$diff_count = count( $orig_rows ) - count( $final_rows );465		if ( $diff_count < 0 ) {466			while ( $diff_count < 0 ) {467				array_push( $orig_rows, $diff_count++ );468			}469		} elseif ( $diff_count > 0 ) {470			$diff_count = -1 * $diff_count;471			while ( $diff_count < 0 ) {472				array_push( $final_rows, $diff_count++ );473			}474		}

Changelog

Introduced in 2.6.0. 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.7.7 tag, from src/wp-includes/class-wp-text-diff-renderer-table.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.