WP_HTML_Decoder::attribute_starts_with( string $haystack, string $search_text, string $case_sensitivity = 'case-sensitive' ): bool
- Since
- 6.6.0
- Source
wp-includes/html-api/class-wp-html-decoder.php:37
Description
Use this method to determine if an attribute value starts with a given string, regardless of how it might be encoded in HTML. For instance, http: could be represented as http: or as http: or as http: or as http:, or in many other ways.
This is equivalent to a byte-prefix test against the decoded attribute value, without the need to allocate and decode the full string.
Example:
$value = 'http://wordpress.org/';
true === WP_HTML_Decoder::attribute_starts_with( $value, 'http:', 'ascii-case-insensitive' );
false === WP_HTML_Decoder::attribute_starts_with( $value, 'https:', 'ascii-case-insensitive' );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
$haystackstring- String containing the raw non-decoded attribute value.
$search_textstring- Does the attribute value start with this plain string.
$case_sensitivitystringoptional- Pass 'ascii-case-insensitive' to ignore ASCII case when matching.
Default 'case-sensitive'.Default:'case-sensitive'
Return value
bool- Whether the attribute value starts with the given string.
Performance profile
How much work a call to WP_HTML_Decoder::attribute_starts_with() 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
- Scaling
- Scales with input
- Instructions
- 13–57
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 69.
Nothing here hands control to plugin code.
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_HTML_Decoder::attribute_starts_with() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 13–27 | none |
$search_at && $haystack_at && $case_sensitivity !== "ascii-case-insensitive" && $next_chunk === null | 34 | ::read_character_reference() |
$search_at && $haystack_at && $case_sensitivity === "ascii-case-insensitive" && $next_chunk === null | 34 | strtolower(), strtolower() |
$search_at && $haystack_at && $case_sensitivity !== "ascii-case-insensitive" | 41–43 | substr_compare() |
$search_at && $haystack_at && $case_sensitivity === "ascii-case-insensitive" && $next_chunk === null | 41 | strtolower(), strtolower(), ::read_character_reference() |
$search_at && $haystack_at && $case_sensitivity !== "ascii-case-insensitive" | 48–50 | ::read_character_reference(), substr_compare() |
$search_at && $haystack_at && $case_sensitivity === "ascii-case-insensitive" | 48–50 | strtolower(), strtolower(), substr_compare() |
$search_at && $haystack_at && $case_sensitivity === "ascii-case-insensitive" | 55–57 | strtolower(), strtolower(), ::read_character_reference(), substr_compare() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 68 | 13–56 | 9 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 69 | 13–57 | 9 | |
| 8.4 | 69 | 13–57 | 9 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 72 | 13–60 | 9 | |
| 8.2 | 72 | 13–60 | 9 | |
| 8.1 | 72 | 13–60 | 9 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 74 | 13–61 | 9 |
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_HTML_Decoder::read_character_reference()Attempt to read a character reference at the given location in a given string, depending on the context in which it's found.
Changelog
Introduced in 6.6.0. Unchanged from 6.7.7 through 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/html-api/class-wp-html-decoder.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.