iframe_header( string $title = '', bool $deprecated = false )

Compatibility

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

Parameters

$titlestringoptional

Title of the Iframe page. Default empty.Default: ''

$deprecatedbooloptional

Not used.Default: false

Performance profile

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

Heavy

Reaches the database via get_user_by().

Scaling

Constant

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

Instructions

167–170

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

Plugin surface

8 hooks

Third-party callbacks on 'admin_enqueue_scripts', 'admin_print_styles-{$hook_suffix}', 'admin_print_styles' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksdo_action()called directly
• cacheobject cachewp_cache_get()one call below iframe_header()
• serializeserialisationmaybe_unserialize()one call below iframe_header()
• querycontent queryget_user_by()one call below iframe_header()

Further down the call graph this can also reach transient. That is 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 iframe_header() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 8

8 hooks fire while iframe_header() runs, in this order:

1. 1
   do_action( admin_enqueue_scripts )actionline 2159 (+29 into the body)

   Fires when enqueuing scripts for all admin pages.

2. 2
   do_action( admin_print_styles-{$hook_suffix} )actionline 2162 (+32 into the body)

   Fires when styles are printed for a specific admin page based on $hook_suffix.

3. 3
   do_action( admin_print_styles )actionline 2165 (+35 into the body)

   Fires when styles are printed for all admin pages.

4. 4
   do_action( admin_print_scripts-{$hook_suffix} )actionline 2168 (+38 into the body)

   Fires when scripts are printed for a specific admin page based on $hook_suffix.

5. 5
   do_action( admin_print_scripts )actionline 2171 (+41 into the body)

   Fires when scripts are printed for all admin pages.

6. 6
   do_action( admin_head-{$hook_suffix} )actionline 2174 (+44 into the body)

   Fires in head section for a specific admin page.

7. 7
   do_action( admin_head )actionline 2177 (+47 into the body)

   Fires in head section for all admin pages.

8. 8
   apply_filters( admin_body_class )filterline 2192 (+62 into the body)

   Filters the CSS classes for the body tag in the admin.

Uses · 16

• show_admin_bar()Sets the display status of the admin bar.
• get_current_screen()Get the current screen object
• get_option()Retrieves an option value based on an option name.
• _wp_admin_html_begin()Prints out the beginning of the admin HTML header.
• bloginfo()Displays information about the current site.
• _e()Displays translated text.
• wp_enqueue_style()Enqueues a CSS stylesheet.
• esc_js()Escapes single quotes, `"`, ``, `&`, and fixes line endings.
• admin_url()Retrieves the URL to the admin area for the current site.
• is_rtl()Determines whether the current locale is right-to-left (RTL).
• do_action()Calls the callback functions that have been added to an action hook.
• sanitize_html_class()Sanitizes an HTML classname to ensure it only contains valid characters.

Used by · 2

• install_plugin_information()Displays plugin information in dialog box form.
• install_theme_information()Displays theme information in dialog box form.

Source code

View on Trac ↗View on GitHub ↗

2130function iframe_header( $title = '', $deprecated = false ) {2131	global $hook_suffix, $admin_body_class, $body_id, $wp_locale;2132 2133	show_admin_bar( false );2134 2135	$admin_body_class = preg_replace( '/[^a-z0-9_-]+/i', '-', $hook_suffix );2136 2137	$current_screen = get_current_screen();2138 2139	header( 'Content-Type: ' . get_option( 'html_type' ) . '; charset=' . get_option( 'blog_charset' ) );2140	_wp_admin_html_begin();2141	?>2142<title><?php bloginfo( 'name' ); ?> &rsaquo; <?php echo $title; ?> &#8212; <?php _e( 'WordPress' ); ?></title>2143	<?php2144	wp_enqueue_style( 'colors' );2145	?>2146<script>2147addLoadEvent = function(func){if(typeof jQuery!=='undefined')jQuery(function(){func();});else if(typeof wpOnload!=='function'){wpOnload=func;}else{var oldonload=wpOnload;wpOnload=function(){oldonload();func();}}};2148function tb_close(){var win=window.dialogArguments||opener||parent||top;win.tb_remove();}2149var ajaxurl = '<?php echo esc_js( admin_url( 'admin-ajax.php', 'relative' ) ); ?>',2150	pagenow = '<?php echo esc_js( $current_screen->id ); ?>',2151	typenow = '<?php echo esc_js( $current_screen->post_type ); ?>',2152	adminpage = '<?php echo esc_js( $admin_body_class ); ?>',2153	thousandsSeparator = '<?php echo esc_js( $wp_locale->number_format['thousands_sep'] ); ?>',2154	decimalPoint = '<?php echo esc_js( $wp_locale->number_format['decimal_point'] ); ?>',2155	isRtl = <?php echo (int) is_rtl(); ?>;2156</script>2157	<?php2158	/** This action is documented in wp-admin/admin-header.php */2159	do_action( 'admin_enqueue_scripts', $hook_suffix );2160 2161	/** This action is documented in wp-admin/admin-header.php */2162	do_action( "admin_print_styles-{$hook_suffix}" );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores2163 2164	/** This action is documented in wp-admin/admin-header.php */2165	do_action( 'admin_print_styles' );2166 2167	/** This action is documented in wp-admin/admin-header.php */2168	do_action( "admin_print_scripts-{$hook_suffix}" ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores2169 2170	/** This action is documented in wp-admin/admin-header.php */2171	do_action( 'admin_print_scripts' );2172 2173	/** This action is documented in wp-admin/admin-header.php */2174	do_action( "admin_head-{$hook_suffix}" ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores2175 2176	/** This action is documented in wp-admin/admin-header.php */2177	do_action( 'admin_head' );2178 2179	$admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_user_locale() ) ) );2180	$admin_body_class .= ' admin-color-' . sanitize_html_class( get_user_option( 'admin_color' ), 'modern' );2181 2182	if ( is_rtl() ) {2183		$admin_body_class .= ' rtl';2184	}2185 2186	?>2187</head>2188	<?php2189	$admin_body_id = isset( $body_id ) ? 'id="' . $body_id . '" ' : '';2190 2191	/** This filter is documented in wp-admin/admin-header.php */2192	$admin_body_classes = apply_filters( 'admin_body_class', '' );2193	$admin_body_classes = ltrim( $admin_body_classes . ' ' . $admin_body_class );2194	?>2195<body <?php echo $admin_body_id; ?>class="wp-admin wp-core-ui no-js iframe <?php echo esc_attr( $admin_body_classes ); ?>">2196<script>2197(function(){2198var c = document.body.className;2199c = c.replace(/no-js/, 'js');2200document.body.className = c;2201})();2202</script>2203	<?php2204}

Changelog

Introduced in 2.7.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.0.4 tag, from src/wp-admin/includes/template.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.