WP_Customize_Section

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 3

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

Properties · 14

$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

WP_Customize_Manager instance.

$idstringpublic

Unique identifier.

$priorityintpublic

Priority of the section which informs load order of sections.

$panelstringpublic

Panel in which to show the section, making it a sub-section.

$capabilitystringpublic

Capability required for the section.

$theme_supportsstring|string[]public

Theme features required to support the section.

$titlestringpublic

Title of the section to show in UI.

$descriptionstringpublic

Description to show in the UI.

$controlsarraypublic

Customizer controls for this section.

$typestringpublic

Type of this section.

$active_callbackcallablepublic

Active callback.

$description_hiddenboolpublic

Show the description or hide it behind the help icon.

Methods · 10

• __construct()Constructor.
• active()Check whether section is active to current Customizer preview.
• active_callback()Default callback used when invoking WP_Customize_Section::active().
• json()Gather the parameters passed to client JavaScript via JSON.
• check_capabilities()Checks required user capabilities and whether the theme has the feature support required by the section.
• get_content()Get the section's content for insertion into the Customizer pane.
• maybe_render()Check capabilities and render the section.
• render()Render the section UI in a subclass.
• print_template()Render the section's JS template.
• render_template()An Underscore (JS) template for rendering this section.

Source code

View on Trac ↗View on GitHub ↗

19#[AllowDynamicProperties]20class WP_Customize_Section {21 22	/**23	 * Incremented with each new class instantiation, then stored in $instance_number.24	 *25	 * Used when sorting two instances whose priorities are equal.26	 *27	 * @since 4.1.028	 * @var int29	 */30	protected static $instance_count = 0;31 32	/**33	 * Order in which this instance was created in relation to other instances.34	 *35	 * @since 4.1.036	 * @var int37	 */38	public $instance_number;39 40	/**41	 * WP_Customize_Manager instance.42	 *43	 * @since 3.4.044	 * @var WP_Customize_Manager45	 */46	public $manager;47 48	/**49	 * Unique identifier.50	 *51	 * @since 3.4.052	 * @var string53	 */54	public $id;55 56	/**57	 * Priority of the section which informs load order of sections.58	 *59	 * @since 3.4.060	 * @var int61	 */62	public $priority = 160;63 64	/**65	 * Panel in which to show the section, making it a sub-section.66	 *67	 * @since 4.0.068	 * @var string69	 */70	public $panel = '';71 72	/**73	 * Capability required for the section.74	 *75	 * @since 3.4.076	 * @var string77	 */78	public $capability = 'edit_theme_options';79 80	/**81	 * Theme features required to support the section.82	 *83	 * @since 3.4.084	 * @var string|string[]85	 */86	public $theme_supports = '';87 88	/**89	 * Title of the section to show in UI.90	 *91	 * @since 3.4.092	 * @var string93	 */94	public $title = '';95 96	/**97	 * Description to show in the UI.98	 *

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.0.4 tag, from src/wp-includes/class-wp-customize-section.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.