wppaste
WordPress

WP_Customize_Section

Since
3.4.0
Source
wp-includes/class-wp-customize-section.php:19
Customize Section class.

Description

A UI container for controls, managed by the WP_Customize_Manager class.

Compatibility

WordPress
since 3.4.0
  • 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).

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.

WP_Customize_Section::active()

  1. apply_filters( customize_section_active )filter line 211

WP_Customize_Section::maybe_render()

  1. do_action( customize_render_section )action line 304
  2. do_action( customize_render_section_{$this->id} )action line 313

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.

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