wppaste
WordPress

WP_Customize_Site_Icon_Control::content_template()

Since
4.5.0
Source
wp-includes/customize/class-wp-customize-site-icon-control.php:52
Renders a JS template for the content of the site icon control.

Compatibility

WordPress
since 4.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_Site_Icon_Control::content_template() 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
58

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

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_Site_Icon_Control::content_template()
  • optionoption read or writeget_option()one call below WP_Customize_Site_Icon_Control::content_template()

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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always58__(), wp_json_encode(), __(), wp_json_encode(), __(), wp_json_encode(), __(), wp_json_encode(), get_bloginfo(), esc_js()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 58 instructions, 58 executed per call, 0 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 · 4

  • wp_json_encode()Encodes a variable into JSON, with some confidence checks.
  • __()Retrieves the translation of $text.
  • esc_js()Escapes single quotes, `"`, ``, `&`, and fixes line endings.
  • get_bloginfo()Retrieves information about the current site.

Source code

	public function content_template() {		?>		<# if ( data.label ) { #>			<span class="customize-control-title">{{ data.label }}</span>		<# } #> 		<# if ( data.attachment && data.attachment.id ) { #>			<div class="attachment-media-view">				<# if ( data.attachment.sizes ) { #>					<style>						:root{							--site-icon-url: url( '{{ data.attachment.sizes.full ? data.attachment.sizes.full.url : data.attachment.url }}' );						}					</style>					<div class="site-icon-preview customizer">						<div class="direction-wrap">							<img src="{{ data.attachment.sizes.full ? data.attachment.sizes.full.url : data.attachment.url }}" class="app-icon-preview" alt="{{								data.attachment.alt ?									wp.i18n.sprintf(										<?php										/* translators: %s: The selected image alt text. */										echo wp_json_encode( __( 'App icon preview: Current image: %s' ) )										?>										,										data.attachment.alt									) :									wp.i18n.sprintf(										<?php										/* translators: %s: The selected image filename. */										echo wp_json_encode( __( 'App icon preview: The current image has no alternative text. The file name is: %s' ) );										?>										,										data.attachment.filename									)							}}" />							<div class="site-icon-preview-browser">								<svg role="img" aria-hidden="true" fill="none" xmlns="http://www.w3.org/2000/svg" class="browser-buttons"><path fill-rule="evenodd" clip-rule="evenodd" d="M0 20a6 6 0 1 1 12 0 6 6 0 0 1-12 0Zm18 0a6 6 0 1 1 12 0 6 6 0 0 1-12 0Zm24-6a6 6 0 1 0 0 12 6 6 0 0 0 0-12Z" /></svg>								<div class="site-icon-preview-tab">									<img src="{{ data.attachment.sizes.full ? data.attachment.sizes.full.url : data.attachment.url }}" class="browser-icon-preview" alt="{{										data.attachment.alt ?											wp.i18n.sprintf(												<?php												/* translators: %s: The selected image alt text. */												echo wp_json_encode( __( 'Browser icon preview: Current image: %s' ) );												?>												,												data.attachment.alt											) :											wp.i18n.sprintf(												<?php												/* translators: %s: The selected image filename. */												echo wp_json_encode( __( 'Browser icon preview: The current image has no alternative text. The file name is: %s' ) );												?>												,												data.attachment.filename											)									}}" />									<div class="site-icon-preview-site-title" aria-hidden="true"><# print( '<?php echo esc_js( get_bloginfo( 'name' ) ); ?>' ) #></div>										<svg role="img" aria-hidden="true" fill="none" xmlns="http://www.w3.org/2000/svg" class="close-button">											<path d="M12 13.0607L15.7123 16.773L16.773 15.7123L13.0607 12L16.773 8.28772L15.7123 7.22706L12 10.9394L8.28771 7.22705L7.22705 8.28771L10.9394 12L7.22706 15.7123L8.28772 16.773L12 13.0607Z" />										</svg>									</div>								</div>							</div>						</div>					</div>				<# } #>				<div class="actions">					<# if ( data.canUpload ) { #>						<button type="button" class="button remove-button"><?php echo $this->button_labels['remove']; ?></button>						<button type="button" class="button upload-button"><?php echo $this->button_labels['change']; ?></button>					<# } #>				</div>			</div>		<# } else { #>			<div class="attachment-media-view">				<# if ( data.canUpload ) { #>					<button type="button" class="upload-button button"><?php echo $this->button_labels['site_icon']; ?></button>				<# } #>				<div class="actions">

Changelog

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