wppaste
WordPress

WP_Customize_Control::__construct( WP_Customize_Manager $manager, string $id, array $args = array() )

Since
3.4.0
Source
wp-includes/class-wp-customize-control.php:216
Constructor.

Description

Supplied $args override class property defaults.

If $args['settings'] is not defined, use the $id as the setting ID.

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.

Parameters

$managerWP_Customize_Manager
Customizer bootstrap instance.
$idstring
Control ID.
$argsarrayoptional
Array of properties for the new Control object. Default empty array.Default: array()

  • $instance_numberint

    Order in which this instance was created in relation to other instances.

  • $managerWP_Customize_Manager

    Customizer bootstrap instance.

  • $idstring

    Control ID.

  • $settingsarray

    All settings tied to the control. If undefined, $id will be used.

  • $settingstringdefault: 'default'

    The primary setting for the control (if there is one).

  • $capabilitystring

    Capability required to use this control. Normally this is empty and the capability is derived from $settings.

  • $priorityintdefault: 10

    Order priority to load the control.

  • $sectionstringdefault: empty

    Section the control belongs to.

  • $labelstringdefault: empty

    Label for the control.

  • $descriptionstringdefault: empty

    Description for the control.

  • $choicesarraydefault: empty array

    List of choices for 'radio' or 'select' type controls, where values are the keys, and labels are the values.

  • $input_attrsarraydefault: empty array

    List of custom input attributes for control output, where attribute names are the keys and values are the values. Not used for 'checkbox', 'radio', 'select', or 'dropdown-pages' control types.

  • $allow_additionbooldefault: false

    Show UI for adding new content, currently only used for the dropdown-pages control.

  • $jsonarray

    Deprecated. Use WP_Customize_Control::json() instead.

  • $typestringdefault: 'text'

    Control type. Core controls include 'text', 'checkbox', 'textarea', 'radio', 'select', and 'dropdown-pages'. Additional input types such as 'email', 'url', 'number', 'hidden', and 'date' are supported implicitly.

  • $active_callbackcallable

    Active callback.

Performance profile

How much work a call to WP_Customize_Control::__construct() 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 what you pass in.

Instructions
36–55

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
5

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

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always36–46get_object_vars(), array_keys()
always47–55get_object_vars(), array_keys(), ->get_setting()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 74 instructions, 36–55 executed per call, 9 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.

Used by · 5

Source code

View on Trac View on GitHub 

	public function __construct( $manager, $id, $args = array() ) {		$keys = array_keys( get_object_vars( $this ) );		foreach ( $keys as $key ) {			if ( isset( $args[ $key ] ) ) {				$this->$key = $args[ $key ];			}		} 		$this->manager = $manager;		$this->id      = $id;		if ( empty( $this->active_callback ) ) {			$this->active_callback = array( $this, 'active_callback' );		}		self::$instance_count += 1;		$this->instance_number = self::$instance_count; 		// Process settings.		if ( ! isset( $this->settings ) ) {			$this->settings = $id;		} 		$settings = array();		if ( is_array( $this->settings ) ) {			foreach ( $this->settings as $key => $setting ) {				$settings[ $key ] = $this->manager->get_setting( $setting );			}		} elseif ( is_string( $this->settings ) ) {			$this->setting       = $this->manager->get_setting( $this->settings );			$settings['default'] = $this->setting;		}		$this->settings = $settings;	}

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-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.