wppaste
WordPress

WP_Customize_Manager::prepare_controls()

Since
3.4.0
Source
wp-includes/class-wp-customize-manager.php:4450
Prepares panels, sections, and controls.

Description

For each, check if required related components exist, whether the user has the necessary capabilities, and sort by priority.

Compatibility

WordPress
since 3.4.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::prepare_controls() 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–70

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

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

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

WhenInstructionsCalls it makes
always67–70wp_list_sort(), wp_list_sort(), wp_list_sort(), array_merge(), wp_list_sort()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 133 instructions, 67–70 executed per call, 12 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 · 1

  • wp_list_sort()Sorts an array of objects or arrays based on one or more orderby arguments.

Used by · 1

Source code

	public function prepare_controls() { 		$controls       = array();		$this->controls = wp_list_sort(			$this->controls,			array(				'priority'        => 'ASC',				'instance_number' => 'ASC',			),			'ASC',			true		); 		foreach ( $this->controls as $id => $control ) {			if ( ! isset( $this->sections[ $control->section ] ) || ! $control->check_capabilities() ) {				continue;			} 			$this->sections[ $control->section ]->controls[] = $control;			$controls[ $id ]                                 = $control;		}		$this->controls = $controls; 		// Prepare sections.		$this->sections = wp_list_sort(			$this->sections,			array(				'priority'        => 'ASC',				'instance_number' => 'ASC',			),			'ASC',			true		);		$sections       = array(); 		foreach ( $this->sections as $section ) {			if ( ! $section->check_capabilities() ) {				continue;			} 			$section->controls = wp_list_sort(				$section->controls,				array(					'priority'        => 'ASC',					'instance_number' => 'ASC',				)			); 			if ( ! $section->panel ) {				// Top-level section.				$sections[ $section->id ] = $section;			} else {				// This section belongs to a panel.				if ( isset( $this->panels [ $section->panel ] ) ) {					$this->panels[ $section->panel ]->sections[ $section->id ] = $section;				}			}		}		$this->sections = $sections; 		// Prepare panels.		$this->panels = wp_list_sort(			$this->panels,			array(				'priority'        => 'ASC',				'instance_number' => 'ASC',			),			'ASC',			true		);		$panels       = array(); 		foreach ( $this->panels as $panel ) {			if ( ! $panel->check_capabilities() ) {				continue;			} 			$panel->sections      = wp_list_sort(				$panel->sections,				array(

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.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 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.