_mb_ord( string $string, "UTF-8"|null $encoding = null ): int|false
- Since
- 7.1.0
- Source
wp-includes/compat.php:211
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$stringstring- Return the code point at the start of this string.
$encoding"UTF-8"|nulloptional- Must be 'UTF-8' or null.Default:
null
Return value
int|false- The Unicode code point for the first character of string or false on failure.
Performance profile
How much work a call to _mb_ord() 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
- Scaling
- Constant
- Instructions
- 5–57
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 86.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _mb_ord() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 5–11 | none |
is_string($string) && $string !== "" && $found_count !== 1 | 21–23 | _wp_scan_utf8() |
is_string($string) && $string !== "" && $found_count === 1 | 27–35 | _wp_scan_utf8(), ord() |
is_string($string) && $string !== "" && $found_count === 1 && $byte_length != 1 && $byte_length == 2 | 37–39 | _wp_scan_utf8(), ord(), ord() |
is_string($string) && $string !== "" && $found_count === 1 && $byte_length != 1 && $byte_length != 2 && $byte_length == 3 | 46–48 | _wp_scan_utf8(), ord(), ord(), ord() |
is_string($string) && $string !== "" && $found_count === 1 && $byte_length != 1 && $byte_length != 2 && $byte_length != 3 && $byte_length == 4 | 55–57 | _wp_scan_utf8(), ord(), ord(), ord(), ord() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 86 instructions, 5–57 executed per call, 9 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 · 1
- _wp_scan_utf8()Finds spans of valid and invalid UTF-8 bytes in a given string.
Used by · 1
- mb_ord()Compat function to mimic mb_ord().
Source code
function _mb_ord( $string, $encoding = null ) { if ( ! is_string( $string ) || '' === $string || ( isset( $encoding ) && 'UTF-8' !== $encoding ) ) { return false; } $byte_length = 0; $invalid_length = 0; $found_count = _wp_scan_utf8( $string, $byte_length, $invalid_length, null, 1 ); if ( 1 !== $found_count ) { return false; } // These are valid code points, so no further validation is required. $b0 = ord( $string[0] ); switch ( $byte_length ) { case 1: return $b0; case 2: return ( ( ( $b0 & 0x1F ) << 6 ) | ( ( ord( $string[1] ) & 0x3F ) ) ); case 3: return ( ( ( $b0 & 0x0F ) << 12 ) | ( ( ord( $string[1] ) & 0x3F ) << 6 ) | ( ( ord( $string[2] ) & 0x3F ) ) ); case 4: return ( ( ( $b0 & 0x07 ) << 18 ) | ( ( ord( $string[1] ) & 0x3F ) << 12 ) | ( ( ord( $string[2] ) & 0x3F ) << 6 ) | ( ( ord( $string[3] ) & 0x3F ) ) ); } return false;}Changelog
Introduced in 7.1.0.
Signature, return type and hooks compared across 1 parsed release.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/compat.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.