wppaste
WordPress

WP_Customize_Background_Position_Control::content_template()

Since
4.7.0
Source
wp-includes/customize/class-wp-customize-background-position-control.php:39
Render a JS template for the content of the position control.

Compatibility

WordPress
since 4.7.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_Background_Position_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
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
67–68

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

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_Background_Position_Control::content_template()

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

WhenInstructionsCalls it makes
always67–68__(), __(), __(), __(), __(), __(), __(), __(), __(), _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: 92 instructions, 67–68 executed per call, 4 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 · 3

  • __()Retrieves the translation of $text.
  • _e()Displays translated text.
  • esc_attr()Escaping for HTML attributes.

Source code

	public function content_template() {		$options = array(			array(				'left top'   => array(					'label' => __( 'Top Left' ),					'icon'  => 'dashicons dashicons-arrow-left-alt',				),				'center top' => array(					'label' => __( 'Top' ),					'icon'  => 'dashicons dashicons-arrow-up-alt',				),				'right top'  => array(					'label' => __( 'Top Right' ),					'icon'  => 'dashicons dashicons-arrow-right-alt',				),			),			array(				'left center'   => array(					'label' => __( 'Left' ),					'icon'  => 'dashicons dashicons-arrow-left-alt',				),				'center center' => array(					'label' => __( 'Center' ),					'icon'  => 'background-position-center-icon',				),				'right center'  => array(					'label' => __( 'Right' ),					'icon'  => 'dashicons dashicons-arrow-right-alt',				),			),			array(				'left bottom'   => array(					'label' => __( 'Bottom Left' ),					'icon'  => 'dashicons dashicons-arrow-left-alt',				),				'center bottom' => array(					'label' => __( 'Bottom' ),					'icon'  => 'dashicons dashicons-arrow-down-alt',				),				'right bottom'  => array(					'label' => __( 'Bottom Right' ),					'icon'  => 'dashicons dashicons-arrow-right-alt',				),			),		);		?>		<# if ( data.label ) { #>			<span class="customize-control-title">{{{ data.label }}}</span>		<# } #>		<# if ( data.description ) { #>			<span class="description customize-control-description">{{{ data.description }}}</span>		<# } #>		<div class="customize-control-content">			<fieldset>				<legend class="screen-reader-text"><span>					<?php					/* translators: Hidden accessibility text. */					_e( 'Image Position' );					?>				</span></legend>				<div class="background-position-control">				<?php foreach ( $options as $group ) : ?>					<div class="button-group">					<?php foreach ( $group as $value => $input ) : ?>						<label>							<input class="ui-helper-hidden-accessible" name="background-position" type="radio" value="<?php echo esc_attr( $value ); ?>">							<span class="button display-options position"><span class="<?php echo esc_attr( $input['icon'] ); ?>" aria-hidden="true"></span></span>							<span class="screen-reader-text"><?php echo $input['label']; ?></span>						</label>					<?php endforeach; ?>					</div>				<?php endforeach; ?>				</div>			</fieldset>		</div>		<?php	}

Changelog

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