WP_Token_Map::read_token( string $text, int $offset = 0, $matched_token_byte_length = null, string $case_sensitivity = 'case-sensitive' ): string|null

Description

false === $smilies->read_token( 'Not sure :?.', 0, $token_byte_length );
'😕' === $smilies->read_token( 'Not sure :?.', 9, $token_byte_length );
2 === $token_byte_length;

while ( $at < strlen( $input ) ) {
 $next_at = strpos( $input, ':', $at );
 if ( false === $next_at ) {
 break;
 }

 $smily = $smilies->read_token( $input, $next_at, $token_byte_length );
 if ( false === $next_at ) {
 ++$at;
 continue;
 }

 $prefix = substr( $input, $at, $next_at - $at );
 $at += $token_byte_length;
 $output .= "{$prefix}{$smily}";
}

Compatibility

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

Parameters

$textstring

String in which to search for a lookup key.

$offsetintoptional

How many bytes into the string where the lookup key ought to start. Default 0.Default: 0

$matched_token_byte_lengthoptional

Default: null

$case_sensitivitystringoptional

Pass 'ascii-case-insensitive' to ignore ASCII case when matching. Default 'case-sensitive'.Default: 'case-sensitive'

Return value

string|null

Mapped value of lookup key if found, otherwise null.

Performance profile

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

16–80

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

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 one call costs · 8 distinct outcomes

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

Uses · 2

• stripos()
• WP_Token_Map::read_small_token()Finds a match for a short word at the index.

Source code

View on Trac ↗View on GitHub ↗

534	public function read_token( string $text, int $offset = 0, &$matched_token_byte_length = null, $case_sensitivity = 'case-sensitive' ): ?string {535		$ignore_case = 'ascii-case-insensitive' === $case_sensitivity;536		$text_length = strlen( $text );537 538		// Search for a long word first, if the text is long enough, and if that fails, a short one.539		if ( $text_length > $this->key_length ) {540			/*541			 * Keys cannot contain null bytes, which is taken care of for the full words,542			 * but here it’s required to reject group keys with null bytes so that the543			 * lookup doesn’t get off track when scanning the group string.544			 */545			if ( strcspn( $text, "\x00", $offset, $this->key_length ) < $this->key_length ) {546				return null;547			}548 549			$group_key = substr( $text, $offset, $this->key_length );550			$group_at  = $ignore_case ? stripos( $this->groups, $group_key ) : strpos( $this->groups, $group_key );551			if ( false === $group_at ) {552				// Perhaps a short word then.553				return strlen( $this->small_words ) > 0554					? $this->read_small_token( $text, $offset, $matched_token_byte_length, $case_sensitivity )555					: null;556			}557 558			$group        = $this->large_words[ $group_at / ( $this->key_length + 1 ) ];559			$group_length = strlen( $group );560			$at           = 0;561			while ( $at < $group_length ) {562				$token_length   = unpack( 'C', $group[ $at++ ] )[1];563				$token          = substr( $group, $at, $token_length );564				$at            += $token_length;565				$mapping_length = unpack( 'C', $group[ $at++ ] )[1];566				$mapping_at     = $at;567 568				if ( 0 === substr_compare( $text, $token, $offset + $this->key_length, $token_length, $ignore_case ) ) {569					$matched_token_byte_length = $this->key_length + $token_length;570					return substr( $group, $mapping_at, $mapping_length );571				}572 573				$at = $mapping_at + $mapping_length;574			}575		}576 577		// Perhaps a short word then.578		return strlen( $this->small_words ) > 0579			? $this->read_small_token( $text, $offset, $matched_token_byte_length, $case_sensitivity )580			: null;581	}

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.