wppaste
WordPress

MO::export_to_file_handle( resource $fh ): true

Source
wp-includes/pomo/mo.php:104

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

$fhresource

Return value

true

Performance profile

How much work a call to MO::export_to_file_handle() 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
Heavy

Reads or writes the filesystem via fwrite().

Scaling
Scales with input

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

Instructions
84–86

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

What it touches

  • filesystemfilesystem accessfwrite()called directly

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

WhenInstructionsCalls it makes
always84–86ksort(), pack(), fwrite(), fseek(), pack(), fwrite(), array_filter(), ->export_headers(), ->strlen(), pack(), fwrite(), fwrite(), fwrite()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 134 instructions, 84–86 executed per call, 4 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 · 4

Used by · 2

Source code

		public function export_to_file_handle( $fh ) {			$entries = array_filter( $this->entries, array( $this, 'is_entry_good_for_export' ) );			ksort( $entries );			$magic                     = 0x950412de;			$revision                  = 0;			$total                     = count( $entries ) + 1; // All the headers are one entry.			$originals_lengths_addr    = 28;			$translations_lengths_addr = $originals_lengths_addr + 8 * $total;			$size_of_hash              = 0;			$hash_addr                 = $translations_lengths_addr + 8 * $total;			$current_addr              = $hash_addr;			fwrite(				$fh,				pack(					'V*',					$magic,					$revision,					$total,					$originals_lengths_addr,					$translations_lengths_addr,					$size_of_hash,					$hash_addr				)			);			fseek( $fh, $originals_lengths_addr ); 			// Headers' msgid is an empty string.			fwrite( $fh, pack( 'VV', 0, $current_addr ) );			++$current_addr;			$originals_table = "\0"; 			$reader = new POMO_Reader(); 			foreach ( $entries as $entry ) {				$originals_table .= $this->export_original( $entry ) . "\0";				$length           = $reader->strlen( $this->export_original( $entry ) );				fwrite( $fh, pack( 'VV', $length, $current_addr ) );				$current_addr += $length + 1; // Account for the NULL byte after.			} 			$exported_headers = $this->export_headers();			fwrite( $fh, pack( 'VV', $reader->strlen( $exported_headers ), $current_addr ) );			$current_addr      += strlen( $exported_headers ) + 1;			$translations_table = $exported_headers . "\0"; 			foreach ( $entries as $entry ) {				$translations_table .= $this->export_translations( $entry ) . "\0";				$length              = $reader->strlen( $this->export_translations( $entry ) );				fwrite( $fh, pack( 'VV', $length, $current_addr ) );				$current_addr += $length + 1;			} 			fwrite( $fh, $originals_table );			fwrite( $fh, $translations_table );			return true;		}

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 7.1.0 tag, from src/wp-includes/pomo/mo.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.