wppaste
WordPress

twentyseventeen_header_image_tag( string $html, object $header, array $attr ): string

Since
Twenty Seventeen 1.0, Twenty Seventeen 3.7 Added larger image size for small screens.
Source
wp-content/themes/twentyseventeen/functions.php:596
Filters the sizes value in the header image markup.

Compatibility

WordPress
since Twenty Seventeen 3.7 Added larger image size for small screens.
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

$htmlstring
The HTML image tag markup being filtered.
$headerobject
The custom header object returned by 'get_custom_header()'.
$attrarray
Array of the attributes for the image tag.

Return value

string
The filtered header image HTML.

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
6–10

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

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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always6–10none

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev106–101
8.5106–101
8.4106–1013 fewer instructions than PHP 8.3
8.3136–131
8.2136–131
8.1136–131
7.4136–131

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.

Source code

View on Trac View on GitHub 

function twentyseventeen_header_image_tag( $html, $header, $attr ) {	if ( isset( $attr['sizes'] ) ) {		$html = str_replace( $attr['sizes'], '(max-width: 767px) 200vw, 100vw', $html );	}	return $html;}

Changelog

Introduced in Twenty Seventeen 3.7 Added larger image size for small screens.. 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.

Twenty Seventeen 3.7 Added larger image size for small screens.
Twenty Seventeen 3.7 Added larger image size for small screens.from the docblock
Twenty Seventeen 1.0
Twenty Seventeen 1.0from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-content/themes/twentyseventeen/functions.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.