wppaste
WordPress

WP_Customize_Manager::render_control_templates()

Since
4.1.0
Source
wp-includes/class-wp-customize-manager.php:4133
Renders JS templates for all registered control types.

Compatibility

WordPress
since 4.1.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_Manager::render_control_templates() 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
Light

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with how much data it finds.

Instructions
87–89

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

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 it touches

  • hookthird-party callbacksapply_filters()one call below WP_Customize_Manager::render_control_templates()

Further down the call graph this can also reach option, 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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always87–89->branching(), __(), __(), _e(), sprintf(), esc_html(), sprintf(), esc_html(), _e(), esc_html_x(), _e(), _e(), esc_html_e(), esc_html_e(), esc_html_e(), _e(), esc_attr_e(), esc_attr_e(), esc_html_e()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 109 instructions, 87–89 executed per call, 3 branches. 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 · 7

  • __()Retrieves the translation of $text.
  • _e()Displays translated text.
  • esc_html()Escaping for HTML blocks.
  • esc_html_x()Translates string with gettext context, and escapes it for safe use in HTML output.
  • esc_html_e()Displays translated text that has been escaped for safe use in HTML output.
  • esc_attr_e()Displays translated text that has been escaped for safe use in an attribute.
  • WP_Customize_Manager::branching()Whether the changeset branching is allowed.

Source code

	public function render_control_templates() {		if ( $this->branching() ) {			$l10n = array(				/* translators: %s: User who is customizing the changeset in customizer. */				'locked'                => __( '%s is already customizing this changeset. Please wait until they are done to try customizing. Your latest changes have been autosaved.' ),				/* translators: %s: User who is customizing the changeset in customizer. */				'locked_allow_override' => __( '%s is already customizing this changeset. Do you want to take over?' ),			);		} else {			$l10n = array(				/* translators: %s: User who is customizing the changeset in customizer. */				'locked'                => __( '%s is already customizing this site. Please wait until they are done to try customizing. Your latest changes have been autosaved.' ),				/* translators: %s: User who is customizing the changeset in customizer. */				'locked_allow_override' => __( '%s is already customizing this site. Do you want to take over?' ),			);		} 		foreach ( $this->registered_control_types as $control_type ) {			$control = new $control_type(				$this,				'temp',				array(					'settings' => array(),				)			);			$control->print_template();		}		?> 		<script type="text/html" id="tmpl-customize-control-default-content">			<#			var inputId = _.uniqueId( 'customize-control-default-input-' );			var descriptionId = _.uniqueId( 'customize-control-default-description-' );			var describedByAttr = data.description ? ' aria-describedby="' + descriptionId + '" ' : '';			#>			<# switch ( data.type ) {				case 'checkbox': #>					<span class="customize-inside-control-row">						<input							id="{{ inputId }}"							{{{ describedByAttr }}}							type="checkbox"							value="{{ data.value }}"							data-customize-setting-key-link="default"						>						<label for="{{ inputId }}">							{{ data.label }}						</label>						<# if ( data.description ) { #>							<span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span>						<# } #>					</span>					<#					break;				case 'radio':					if ( ! data.choices ) {						return;					}					#>					<# if ( data.label ) { #>						<label for="{{ inputId }}" class="customize-control-title">							{{ data.label }}						</label>					<# } #>					<# if ( data.description ) { #>						<span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span>					<# } #>					<# _.each( data.choices, function( val, key ) { #>						<span class="customize-inside-control-row">							<#							var value, text;							if ( _.isObject( val ) ) {								value = val.value;								text = val.text;							} else {								value = key;								text = val;							}							#>							<input

Changelog

Introduced in 4.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.0.4 tag, from src/wp-includes/class-wp-customize-manager.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.