twentyfourteen_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 twentyfourteen_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

9

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

Plugin surface

1 hook

Third-party callbacks on 'twentyfourteen_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 query, option, cache, serialize and transient. 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 twentyfourteen_custom_header_setup() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   apply_filters( twentyfourteen_custom_header_args )filterline 40 (+21 into the body)

   Filters Twenty Fourteen custom-header support arguments.

Uses · 2

• add_theme_support()Registers theme support for a given feature.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

View on Trac ↗View on GitHub ↗

19function twentyfourteen_custom_header_setup() {20	add_theme_support(21		'custom-header',22		/**23		 * Filters Twenty Fourteen custom-header support arguments.24		 *25		 * @since Twenty Fourteen 1.026		 *27		 * @param array $args {28		 *     An array of custom-header support arguments.29		 *30		 *     @type bool   $header_text            Whether to display custom header text. Default false.31		 *     @type int    $width                  Width in pixels of the custom header image. Default 1260.32		 *     @type int    $height                 Height in pixels of the custom header image. Default 240.33		 *     @type bool   $flex_height            Whether to allow flexible-height header images. Default true.34		 *     @type string $admin_head_callback    Callback function used to style the image displayed in35		 *                                          the Appearance > Header screen.36		 *     @type string $admin_preview_callback Callback function used to create the custom header markup in37		 *                                          the Appearance > Header screen.38		 * }39		 */40		apply_filters(41			'twentyfourteen_custom_header_args',42			array(43				'default-text-color'     => 'fff',44				'width'                  => 1260,45				'height'                 => 240,46				'flex-height'            => true,47				'wp-head-callback'       => 'twentyfourteen_header_style',48				'admin-head-callback'    => 'twentyfourteen_admin_header_style',49				'admin-preview-callback' => 'twentyfourteen_admin_header_image',50			)51		)52	);53}

Changelog

Introduced in Twenty Fourteen 1.0. 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/twentyfourteen/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.