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

Description

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', 'textarea', 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.

Used by · 5

• WP_Customize_Color_Control::__construct()Constructor.
• WP_Customize_Manager::add_control()Adds a customize control.
• WP_Customize_Media_Control::__construct()Constructor.
• WP_Customize_Nav_Menu_Item_Control::__construct()Constructor.
• WP_Customize_New_Menu_Control::__construct()Constructor.

Source

View on Trac ↗View on GitHub ↗

211	public function __construct( $manager, $id, $args = array() ) {212		$keys = array_keys( get_object_vars( $this ) );213		foreach ( $keys as $key ) {214			if ( isset( $args[ $key ] ) ) {215				$this->$key = $args[ $key ];216			}217		}218 219		$this->manager = $manager;220		$this->id      = $id;221		if ( empty( $this->active_callback ) ) {222			$this->active_callback = array( $this, 'active_callback' );223		}224		self::$instance_count += 1;225		$this->instance_number = self::$instance_count;226 227		// Process settings.228		if ( ! isset( $this->settings ) ) {229			$this->settings = $id;230		}231 232		$settings = array();233		if ( is_array( $this->settings ) ) {234			foreach ( $this->settings as $key => $setting ) {235				$settings[ $key ] = $this->manager->get_setting( $setting );236			}237		} elseif ( is_string( $this->settings ) ) {238			$this->setting       = $this->manager->get_setting( $this->settings );239			$settings['default'] = $this->setting;240		}241		$this->settings = $settings;242	}

History

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