wp_sizes_attribute_includes_valid_auto( string $sizes_attr ): bool
- Since
- 6.7.0
- Source
wp-includes/media.php:2179
Description
Per the HTML spec, if present it must be the first entry.
Compatibility
- WordPress
- since 6.7.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
$sizes_attrstring- The 'sizes' attribute value.
Return value
bool- True if the 'auto' keyword is present, false otherwise.
Performance profile
How much work a call to wp_sizes_attribute_includes_valid_auto() 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
- 14
- Plugin surface
- None
- Called by
- 2
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. The body compiles to 14.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_sizes_attribute_includes_valid_auto() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 14 | explode(), strtolower() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 14 | 14 | 0 | |
| 8.5 | 14 | 14 | 0 | |
| 8.4 | 14 | 14 | 0 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 17 | 17 | 0 | |
| 8.2 | 17 | 17 | 0 | |
| 8.1 | 17 | 17 | 0 | |
| 7.4 | 17 | 17 | 0 |
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.
Used by · 2
- wp_get_attachment_image()Gets an HTML img element representing an image attachment.
- wp_img_tag_add_auto_sizes()Adds 'auto' to the sizes attribute to the image, if the image is lazy loaded and does not already include it.
Source code
function wp_sizes_attribute_includes_valid_auto( string $sizes_attr ): bool { list( $first_size ) = explode( ',', $sizes_attr, 2 ); return 'auto' === strtolower( trim( $first_size, " \t\f\r\n" ) );}Changelog
Introduced in 6.7.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/media.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.