wppaste
WordPress

WP_Token_Map::from_precomputed_table( array $state ): WP_Token_Map

Since
6.6.0
Source
wp-includes/class-wp-token-map.php:388
Creates a token map from a pre-computed table.

Description

This skips the initialization cost of generating the table.

This function should only be used to load data created with WP_Token_Map::precomputed_php_source_tag().

Compatibility

WordPress
since 6.6.0
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

$statearray
Stores pre-computed state for directly loading into a Token Map.

  • $storage_versionstring

    Which version of the code produced this state.

  • $key_lengthint

    Group key length.

  • $groupsstring

    Group lookup index.

  • $large_wordsarray

    Large word groups and packed strings.

  • $small_wordsstring

    Small words packed string.

  • $small_mappingsarray

    Small word mappings.

Return value

WP_Token_Map
Map with precomputed data loaded.

Performance profile

How much work a call to WP_Token_Map::from_precomputed_table() 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
14–38

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksdo_action()one call below WP_Token_Map::from_precomputed_table()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

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

WhenInstructionsCalls it makes
always14–23__(), _doing_it_wrong()
always25–34__(), sprintf(), _doing_it_wrong()
always29–38none

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 63 instructions, 14–38 executed per call, 7 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 · 3

  • _doing_it_wrong()Marks something as being incorrectly called.
  • __()Retrieves the translation of $text.
  • WP_Token_Map::__construct()

Source code

View on Trac View on GitHub 

	public static function from_precomputed_table( $state ): ?WP_Token_Map {		$has_necessary_state = isset(			$state['storage_version'],			$state['key_length'],			$state['groups'],			$state['large_words'],			$state['small_words'],			$state['small_mappings']		); 		if ( ! $has_necessary_state ) {			_doing_it_wrong(				__METHOD__,				__( 'Missing required inputs to pre-computed WP_Token_Map.' ),				'6.6.0'			);			return null;		} 		if ( self::STORAGE_VERSION !== $state['storage_version'] ) {			_doing_it_wrong(				__METHOD__,				/* translators: 1: version string, 2: version string. */				sprintf( __( 'Loaded version \'%1$s\' incompatible with expected version \'%2$s\'.' ), $state['storage_version'], self::STORAGE_VERSION ),				'6.6.0'			);			return null;		} 		$map = new WP_Token_Map(); 		$map->key_length     = $state['key_length'];		$map->groups         = $state['groups'];		$map->large_words    = $state['large_words'];		$map->small_words    = $state['small_words'];		$map->small_mappings = $state['small_mappings']; 		return $map;	}

Changelog

Introduced in 6.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 7.1.0 tag, from src/wp-includes/class-wp-token-map.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.