WP_Customize_Control

Hooks fired · 3

Every hook that fires from inside WP_Customize_Control, in the order it appears in the class, grouped by the method that fires it.

Properties · 17

$instance_countintprotected static

Incremented with each new class instantiation, then stored in $instance_number.

$instance_numberintpublic

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

$managerWP_Customize_Managerpublic

Customizer manager.

$idstringpublic

Control ID.

$settingsarraypublic

All settings tied to the control.

$settingstring|WP_Customize_Setting|nullpublic

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

$capabilitystringpublic

Capability required to use this control.

$priorityintpublic

Order priority to load the control in Customizer.

$sectionstringpublic

Section the control belongs to.

$labelstringpublic

Label for the control.

$descriptionstringpublic

Description for the control.

$choicesarraypublic

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

$input_attrsarraypublic

List of custom input attributes for control output, where attribute names are the keys and values are the values.

$allow_additionboolpublic

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

$jsonarraypublic

$typestringpublic

Control's Type.

$active_callbackcallablepublic

Callback.

Methods · 17

• __construct()Constructor.
• enqueue()Enqueue control related scripts/styles.
• active()Check whether control is active to current Customizer preview.
• active_callback()Default callback used when invoking WP_Customize_Control::active().
• value()Fetch a setting's value.
• to_json()Refresh the parameters passed to the JavaScript via JSON.
• json()Get the data to export to the client via JSON.
• check_capabilities()Checks if the user can use this control.
• get_content()Get the control's content for insertion into the Customizer pane.
• maybe_render()Check capabilities and render the control.
• render()Renders the control wrapper and calls $this->render_content() for the internals.
• get_link()Get the data link attribute for a setting.
• link()Render the data link attribute for the control's input element.
• input_attrs()Render the custom attributes for the control's input element.
• render_content()Render the control's content.
• print_template()Render the control's JS template.
• content_template()An Underscore (JS) template for this control's content (but not its container).

Source

View on Trac ↗View on GitHub ↗

15#[AllowDynamicProperties]16class WP_Customize_Control {17 18	/**19	 * Incremented with each new class instantiation, then stored in $instance_number.20	 *21	 * Used when sorting two instances whose priorities are equal.22	 *23	 * @since 4.1.024	 * @var int25	 */26	protected static $instance_count = 0;27 28	/**29	 * Order in which this instance was created in relation to other instances.30	 *31	 * @since 4.1.032	 * @var int33	 */34	public $instance_number;35 36	/**37	 * Customizer manager.38	 *39	 * @since 3.4.040	 * @var WP_Customize_Manager41	 */42	public $manager;43 44	/**45	 * Control ID.46	 *47	 * @since 3.4.048	 * @var string49	 */50	public $id;51 52	/**53	 * All settings tied to the control.54	 *55	 * @since 3.4.056	 * @var array57	 */58	public $settings;59 60	/**61	 * The primary setting for the control (if there is one).62	 *63	 * @since 3.4.064	 * @var string|WP_Customize_Setting|null65	 */66	public $setting = 'default';67 68	/**69	 * Capability required to use this control.70	 *71	 * Normally this is empty and the capability is derived from the capabilities72	 * of the associated `$settings`.73	 *74	 * @since 4.5.075	 * @var string76	 */77	public $capability;78 79	/**80	 * Order priority to load the control in Customizer.81	 *82	 * @since 3.4.083	 * @var int84	 */85	public $priority = 10;86 87	/**88	 * Section the control belongs to.89	 *90	 * @since 3.4.091	 * @var string92	 */93	public $section = '';94

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.