wppaste
WordPress

wp_customize_support_script()

Since
3.4.0, 4.7.0, 5.5.0
Source
wp-includes/theme.php:3795
Prints a script to check whether or not the Customizer is supported, and apply either the no-customize-support or customize-support class to the body.

Description

This function MUST be called inside the body tag.

Ideally, call this function immediately after the body tag is opened.
This prevents a flash of unstyled content.

It is also recommended that you add the "no-customize-support" class to the body tag by default.

Compatibility

WordPress
since 5.5.0
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.

Performance profile

How much work a call to wp_customize_support_script() 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
38–39

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

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

WhenInstructionsCalls it makes
always38–39admin_url(), parse_url(), home_url(), parse_url(), strtolower(), strtolower(), ob_start(), ob_get_clean(), wp_remove_surrounding_empty_script_tags(), wp_print_inline_script_tag()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 40 instructions, 38–39 executed per call, 1 branch. The work does not change between versions.

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.

Uses · 4

Source code

function wp_customize_support_script() {	$admin_origin = parse_url( admin_url() );	$home_origin  = parse_url( home_url() );	$cross_domain = ( strtolower( $admin_origin['host'] ) !== strtolower( $home_origin['host'] ) );	ob_start();	?>	<script>		(function() {			var request, b = document.body, c = 'className', cs = 'customize-support', rcs = new RegExp('(^|\\s+)(no-)?'+cs+'(\\s+|$)'); 	<?php	if ( $cross_domain ) : ?>			request = (function(){ var xhr = new XMLHttpRequest(); return ('withCredentials' in xhr); })();	<?php	else : ?>			request = true;	<?php	endif; ?> 			b[c] = b[c].replace( rcs, ' ' );			// The customizer requires postMessage and CORS (if the site is cross domain).			b[c] += ( window.postMessage && request ? ' ' : ' no-' ) + cs;		}());	</script>	<?php	wp_print_inline_script_tag( wp_remove_surrounding_empty_script_tags( ob_get_clean() ) . "\n//# sourceURL=" . rawurlencode( __FUNCTION__ ) );}

Changelog

Introduced in 3.4.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.

5.5.0
IE8 and older are no longer supported.from the docblock
4.7.0
Support for IE8 and below is explicitly removed via conditional comments.from the docblock
3.4.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/theme.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.