wp_iframe( callable $content_func, mixed $args )

Compatibility

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

Parameters

$content_funccallable

Function that outputs the content.

$argsmixed

Optional additional parameters to pass to the callback function when it's called.

Performance profile

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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

89–107

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

Plugin surface

9 hooks

Third-party callbacks on 'admin_enqueue_scripts', 'admin_print_styles-media-upload-popup', 'admin_print_styles' run inside this call, and their cost is not bounded by anything here.

Called by

3

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

What it touches

• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()one call below wp_iframe()

Further down the call graph this can also reach cache, serialize, query 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 · 4 distinct outcomes

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

Hooks and filters fired · 9

9 hooks fire while wp_iframe() runs, in this order:

1. 1
   do_action( admin_enqueue_scripts )actionline 578 (+25 into the body)

   Fires when enqueuing scripts for all admin pages.

2. 2
   do_action( admin_print_styles-media-upload-popup )actionline 585 (+32 into the body)

   Fires when admin styles enqueued for the legacy (pre-3.5.0) media upload popup are printed.

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

   Fires when styles are printed for all admin pages.

4. 4
   do_action( admin_print_scripts-media-upload-popup )actionline 595 (+42 into the body)

   Fires when admin scripts enqueued for the legacy (pre-3.5.0) media upload popup are printed.

5. 5
   do_action( admin_print_scripts )actionline 598 (+45 into the body)

   Fires when scripts are printed for all admin pages.

6. 6
   do_action( admin_head-media-upload-popup )actionline 606 (+53 into the body)

   Fires when scripts enqueued for the admin header for the legacy (pre-3.5.0) media upload popup are printed.

7. 7
   do_action( admin_head )actionline 609 (+56 into the body)

   Fires in head section for all admin pages.

8. 8
   do_action( admin_head_{$content_func} )actionline 621 (+68 into the body)

   Fires in the admin header for each specific form tab in the legacy (pre-3.5.0) media upload popup.

9. 9
   do_action( admin_print_footer_scripts )actionline 641 (+88 into the body)

   Prints any scripts and data queued for the footer.

Uses · 11

• _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.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• 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.
• get_user_option()Retrieves user option that can be either per Site or per Network.

Used by · 3

• media_upload_gallery()Retrieves the legacy media uploader form in an iframe.
• media_upload_library()Retrieves the legacy media library form in an iframe.
• wp_media_upload_handler()Handles the process of uploading media.

Source code

View on Trac ↗View on GitHub ↗

553function wp_iframe( $content_func, ...$args ) {554	global $body_id;555 556	_wp_admin_html_begin();557	?>558	<title><?php bloginfo( 'name' ); ?> &rsaquo; <?php _e( 'Uploads' ); ?> &#8212; <?php _e( 'WordPress' ); ?></title>559	<?php560 561	wp_enqueue_style( 'colors' );562	// Check callback name for 'media'.563	if (564		( is_array( $content_func ) && ! empty( $content_func[1] ) && str_starts_with( (string) $content_func[1], 'media' ) ) ||565		( ! is_array( $content_func ) && str_starts_with( $content_func, 'media' ) )566	) {567		wp_enqueue_style( 'deprecated-media' );568	}569 570	?>571	<script>572	addLoadEvent = function(func){if(typeof jQuery!=='undefined')jQuery(function(){func();});else if(typeof wpOnload!=='function'){wpOnload=func;}else{var oldonload=wpOnload;wpOnload=function(){oldonload();func();}}};573	var ajaxurl = '<?php echo esc_js( admin_url( 'admin-ajax.php', 'relative' ) ); ?>', pagenow = 'media-upload-popup', adminpage = 'media-upload-popup',574	isRtl = <?php echo (int) is_rtl(); ?>;575	</script>576	<?php577	/** This action is documented in wp-admin/admin-header.php */578	do_action( 'admin_enqueue_scripts', 'media-upload-popup' );579 580	/**581	 * Fires when admin styles enqueued for the legacy (pre-3.5.0) media upload popup are printed.582	 *583	 * @since 2.9.0584	 */585	do_action( 'admin_print_styles-media-upload-popup' );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores586 587	/** This action is documented in wp-admin/admin-header.php */588	do_action( 'admin_print_styles' );589 590	/**591	 * Fires when admin scripts enqueued for the legacy (pre-3.5.0) media upload popup are printed.592	 *593	 * @since 2.9.0594	 */595	do_action( 'admin_print_scripts-media-upload-popup' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores596 597	/** This action is documented in wp-admin/admin-header.php */598	do_action( 'admin_print_scripts' );599 600	/**601	 * Fires when scripts enqueued for the admin header for the legacy (pre-3.5.0)602	 * media upload popup are printed.603	 *604	 * @since 2.9.0605	 */606	do_action( 'admin_head-media-upload-popup' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores607 608	/** This action is documented in wp-admin/admin-header.php */609	do_action( 'admin_head' );610 611	if ( is_string( $content_func ) ) {612		/**613		 * Fires in the admin header for each specific form tab in the legacy614		 * (pre-3.5.0) media upload popup.615		 *616		 * The dynamic portion of the hook name, `$content_func`, refers to the form617		 * callback for the media upload type.618		 *619		 * @since 2.5.0620		 */621		do_action( "admin_head_{$content_func}" );622	}623 624	$body_id_attr = '';625 626	if ( isset( $body_id ) ) {627		$body_id_attr = ' id="' . $body_id . '"';628	}629 630	?>631	</head>632	<body<?php echo $body_id_attr; ?> class="wp-core-ui no-js <?php echo 'admin-color-' . sanitize_html_class( get_user_option( 'admin_color' ), 'modern' ); ?>">

Changelog

Introduced in 2.5.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-admin/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.