wpseek.com
A WordPress-centric search engine for devs and theme authors



_wp_utf8_codepoint_span › WordPress Function

Since6.9.0
Deprecatedn/a
› _wp_utf8_codepoint_span ( $text, $byte_offset, $max_code_points, $found_code_points = 0 )
Access:
  • private
Parameters: (4)
  • (string) $text Count bytes of span in this text.
    Required: Yes
  • (int) $byte_offset Start counting at this byte offset.
    Required: Yes
  • (int) $max_code_points Stop counting after this many code points have been seen, or at the end of the string.
    Required: Yes
  • (?int) $found_code_points Optional. Will be set to number of found code points in span, as this might be smaller than the maximum count if the string is not long enough.
    Required: No
    Default: —
Returns:
  • (int) Number of bytes spanned by the code points.
Defined at:
Codex:

Given a starting offset within a string and a maximum number of code points, return how many bytes are occupied by the span of characters.

Invalid spans of bytes count as a single code point according to the maximal subpart rule. This function is a fallback method for calling strlen( mb_substr( substr( $text, $at ), 0, $max_code_points ) ).


Related Functions: _wp_utf8_codepoint_count, _wp_utf8_encode_fallback, _wp_utf8_decode_fallback, _wp_put_post_revision, wp_set_comment_status

Source 

function _wp_utf8_codepoint_span( string $text, int $byte_offset, int $max_code_points, ?int &$found_code_points = 0 ): int {
	$was_at            = $byte_offset;
	$invalid_length    = 0;
	$end               = strlen( $text );
	$found_code_points = 0;

	while ( $byte_offset < $end && $found_code_points < $max_code_points ) {
		$needed      = $max_code_points - $found_code_points;
		$chunk_count = _wp_scan_utf8( $text, $byte_offset, $invalid_length, null, $needed );

		$found_code_points += $chunk_count;

		// Invalid spans only convey one code point count regardless of how long they are.
		if ( 0 !== $invalid_length && $found_code_points < $max_code_points ) {
			++$found_code_points;
			$byte_offset += $invalid_length;
		}
	}

	return $byte_offset - $was_at;
}