twentyseventeen_custom_header_setup()

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

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

29

Executed per call on PHP 8.5. The body compiles to 29.

Plugin surface

1 hook

Third-party callbacks on 'twentyseventeen_custom_header_args' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

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_custom_header_setup() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while twentyseventeen_custom_header_setup() runs, in this order:

1. 1
   apply_filters( twentyseventeen_custom_header_args )filterline 38 (+21 into the body)

   Filters Twenty Seventeen custom-header support arguments.

Uses · 5

• add_theme_support()Registers theme support for a given feature.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_parent_theme_file_uri()Retrieves the URL of a file in the parent theme.
• register_default_headers()Registers a selection of default headers to be displayed by the custom header admin UI.
• __()Retrieves the translation of $text.

Source code

View on Trac ↗View on GitHub ↗

17function twentyseventeen_custom_header_setup() {18 19	add_theme_support(20		'custom-header',21		/**22		 * Filters Twenty Seventeen custom-header support arguments.23		 *24		 * @since Twenty Seventeen 1.025		 *26		 * @param array $args {27		 *     An array of custom-header support arguments.28		 *29		 *     @type string $default-image    Default image of the header.30		 *     @type int    $width            Width in pixels of the custom header image. Default 954.31		 *     @type int    $height           Height in pixels of the custom header image. Default 1300.32		 *     @type string $flex-height      Flex support for height of header.33		 *     @type string $video            Video support for header.34		 *     @type string $wp-head-callback Callback function used to styles the header image and text35		 *                                    displayed on the blog.36		 * }37		 */38		apply_filters(39			'twentyseventeen_custom_header_args',40			array(41				'default-image'    => get_parent_theme_file_uri( '/assets/images/header.jpg' ),42				'width'            => 2000,43				'height'           => 1200,44				'flex-height'      => true,45				'video'            => true,46				'wp-head-callback' => 'twentyseventeen_header_style',47			)48		)49	);50 51	register_default_headers(52		array(53			'default-image' => array(54				'url'           => '%s/assets/images/header.jpg',55				'thumbnail_url' => '%s/assets/images/header.jpg',56				'description'   => __( 'Default Header Image', 'twentyseventeen' ),57			),58		)59	);60}

Changelog

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.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-content/themes/twentyseventeen/inc/custom-header.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.