WP_Customize_Section
概述
WP_Customize_Section 是 WordPress 自定义工具（Customizer）中的一个类，用于管理控件的 UI 容器。它由 WP_Customize_Manager 类管理，提供了一系列方法和属性来定义和渲染自定义工具中的部分。
关键要点
- WP_Customize_Section 是自定义工具中控件的容器，用于组织和显示设置选项。
- 类包含多个核心方法，如 active() 检查部分是否激活、json() 导出参数到 JavaScript、check_capabilities() 验证用户权限和主题支持。
- 重要属性包括 id、priority、panel、capability、theme_supports、title、description 和 type，用于配置部分的行为和外观。
- 支持通过 active_callback 自定义激活逻辑，以及通过 render() 和 print_template() 方法进行 UI 渲染。
- 继承自 WP_Customize_Section 的子类（如 WP_Customize_Nav_Menu_Section）可用于特定场景。
代码示例
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;
$this->controls = array(); // Users cannot customize the $controls array.
}注意事项
- WP_Customize_Section 的渲染默认通过 JavaScript 模板处理，开发者应使用 print_template() 方法或自定义子类来扩展功能。
- 在自定义部分时，确保正确设置 capability 和 theme_supports 属性，以控制访问权限和主题兼容性。
- 使用 active_callback 可以动态控制部分的显示，例如基于当前预览的 URL。
Customize Section class.
Description
A UI container for controls, managed by the WP_Customize_Manager class.
See also
Methods
| Name | Description |
|---|---|
| WP_Customize_Section::__construct | Constructor. |
| WP_Customize_Section::active | Check whether section is active to current Customizer preview. |
| WP_Customize_Section::active_callback | Default callback used when invoking WP_Customize_Section::active(). |
| WP_Customize_Section::check_capabilities | Checks required user capabilities and whether the theme has the feature support required by the section. |
| WP_Customize_Section::get_content | Get the section’s content for insertion into the Customizer pane. |
| WP_Customize_Section::json | Gather the parameters passed to client JavaScript via JSON. |
| WP_Customize_Section::maybe_render | Check capabilities and render the section. |
| WP_Customize_Section::print_template | Render the section’s JS template. |
| WP_Customize_Section::render | Render the section UI in a subclass. |
| WP_Customize_Section::render_template | An Underscore (JS) template for rendering this section. |
Source
class WP_Customize_Section {
/**
* Incremented with each new class instantiation, then stored in $instance_number.
*
* Used when sorting two instances whose priorities are equal.
*
* @since 4.1.0
* @var int
*/
protected static $instance_count = 0;
/**
* Order in which this instance was created in relation to other instances.
*
* @since 4.1.0
* @var int
*/
public $instance_number;
/**
* WP_Customize_Manager instance.
*
* @since 3.4.0
* @var WP_Customize_Manager
*/
public $manager;
/**
* Unique identifier.
*
* @since 3.4.0
* @var string
*/
public $id;
/**
* Priority of the section which informs load order of sections.
*
* @since 3.4.0
* @var int
*/
public $priority = 160;
/**
* Panel in which to show the section, making it a sub-section.
*
* @since 4.0.0
* @var string
*/
public $panel = '';
/**
* Capability required for the section.
*
* @since 3.4.0
* @var string
*/
public $capability = 'edit_theme_options';
/**
* Theme features required to support the section.
*
* @since 3.4.0
* @var string|string[]
*/
public $theme_supports = '';
/**
* Title of the section to show in UI.
*
* @since 3.4.0
* @var string
*/
public $title = '';
/**
* Description to show in the UI.
*
* @since 3.4.0
* @var string
*/
public $description = '';
/**
* Customizer controls for this section.
*
* @since 3.4.0
* @var array
*/
public $controls;
/**
* Type of this section.
*
* @since 4.1.0
* @var string
*/
public $type = 'default';
/**
* Active callback.
*
* @since 4.1.0
*
* @see WP_Customize_Section::active()
*
* @var callable Callback is called with one argument, the instance of
* WP_Customize_Section, and returns bool to indicate whether
* the section is active (such as it relates to the URL currently
* being previewed).
*/
public $active_callback = '';
/**
* Show the description or hide it behind the help icon.
*
* @since 4.7.0
*
* @var bool Indicates whether the Section's description should be
* hidden behind a help icon ("?") in the Section header,
* similar to how help icons are displayed on Panels.
*/
public $description_hidden = false;
/**
* Constructor.
*
* Any supplied $args override class property defaults.
*
* @since 3.4.0
*
* @param WP_Customize_Manager $manager Customizer bootstrap instance.
* @param string $id A specific ID of the section.
* @param array $args {
* Optional. Array of properties for the new Section object. Default empty array.
*
* @type int $priority Priority of the section, defining the display order
* of panels and sections. Default 160.
* @type string $panel The panel this section belongs to (if any).
* Default empty.
* @type string $capability Capability required for the section.
* Default 'edit_theme_options'
* @type string|string[] $theme_supports Theme features required to support the section.
* @type string $title Title of the section to show in UI.
* @type string $description Description to show in the UI.
* @type string $type Type of the section.
* @type callable $active_callback Active callback.
* @type bool $description_hidden Hide the description behind a help icon,
* instead of inline above the first control.
* Default false.
* }
*/
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;
$this->controls = array(); // Users cannot customize the $controls array.
}
/**
* Check whether section is active to current Customizer preview.
*
* @since 4.1.0
*
* @return bool Whether the section is active to the current preview.
*/
final public function active() {
$section = $this;
$active = call_user_func( $this->active_callback, $this );
/**
* Filters response of WP_Customize_Section::active().
*
* @since 4.1.0
*
* @param bool $active Whether the Customizer section is active.
* @param WP_Customize_Section $section WP_Customize_Section instance.
*/
$active = apply_filters( 'customize_section_active', $active, $section );
return $active;
}
/**
* Default callback used when invoking WP_Customize_Section::active().
*
* Subclasses can override this with their specific logic, or they may provide
* an 'active_callback' argument to the constructor.
*
* @since 4.1.0
*
* @return true Always true.
*/
public function active_callback() {
return true;
}
/**
* Gather the parameters passed to client JavaScript via JSON.
*
* @since 4.1.0
*
* @return array The array to be exported to the client as JSON.
*/
public function json() {
$array = wp_array_slice_assoc( (array) $this, array( 'id', 'description', 'priority', 'panel', 'type', 'description_hidden' ) );
$array['title'] = html_entity_decode( $this->title, ENT_QUOTES, get_bloginfo( 'charset' ) );
$array['content'] = $this->get_content();
$array['active'] = $this->active();
$array['instanceNumber'] = $this->instance_number;
if ( $this->panel ) {
/* translators: ▸ is the unicode right-pointing triangle. %s: Section title in the Customizer. */
$array['customizeAction'] = sprintf( __( 'Customizing ▸ %s' ), esc_html( $this->manager->get_panel( $this->panel )->title ) );
} else {
$array['customizeAction'] = __( 'Customizing' );
}
return $array;
}
/**
* Checks required user capabilities and whether the theme has the
* feature support required by the section.
*
* @since 3.4.0
*
* @return bool False if theme doesn't support the section or user doesn't have the capability.
*/
final public function check_capabilities() {
if ( $this->capability && ! current_user_can( $this->capability ) ) {
return false;
}
if ( $this->theme_supports && ! current_theme_supports( ...(array) $this->theme_supports ) ) {
return false;
}
return true;
}
/**
* Get the section's content for insertion into the Customizer pane.
*
* @since 4.1.0
*
* @return string Contents of the section.
*/
final public function get_content() {
ob_start();
$this->maybe_render();
return trim( ob_get_clean() );
}
/**
* Check capabilities and render the section.
*
* @since 3.4.0
*/
final public function maybe_render() {
if ( ! $this->check_capabilities() ) {
return;
}
/**
* Fires before rendering a Customizer section.
*
* @since 3.4.0
*
* @param WP_Customize_Section $section WP_Customize_Section instance.
*/
do_action( 'customize_render_section', $this );
/**
* Fires before rendering a specific Customizer section.
*
* The dynamic portion of the hook name, `$this->id`, refers to the ID
* of the specific Customizer section to be rendered.
*
* @since 3.4.0
*/
do_action( "customize_render_section_{$this->id}" );
$this->render();
}
/**
* Render the section UI in a subclass.
*
* Sections are now rendered in JS by default, see WP_Customize_Section::print_template().
*
* @since 3.4.0
*/
protected function render() {}
/**
* Render the section's JS template.
*
* This function is only run for section types that have been registered with
* WP_Customize_Manager::register_section_type().
*
* @since 4.3.0
*
* @see WP_Customize_Manager::render_template()
*/
public function print_template() {
?>
<script type="text/html" id="tmpl-customize-section-<?php echo $this->type; ?>"></script>
<li id="accordion-section-{{ data.id }}" class="accordion-section control-section control-section-{{ data.type }}">
<h3 class="accordion-section-title">
<button type="button" class="accordion-trigger" aria-expanded="false" aria-controls="{{ data.id }}-content">
{{ data.title }}
</button>
</h3>
<ul class="accordion-section-content" id="{{ data.id }}-content">
<li class="customize-section-description-container section-meta <# if ( data.description_hidden ) { #>customize-info<# } #>">
<div class="customize-section-title">
<button class="customize-section-back" tabindex="-1">
<span class="screen-reader-text">
</span>
</button>
<h3>
<span class="customize-action">
{{{ data.customizeAction }}}
</span>
{{ data.title }}
</h3>
<# if ( data.description && data.description_hidden ) { #>
<button type="button" class="customize-help-toggle dashicons dashicons-editor-help" aria-expanded="false"><span class="screen-reader-text">
</span></button>
<div class="description customize-section-description">
{{{ data.description }}}
</div>
<# } #>
<div class="customize-control-notifications-container"></div>
</div>
<# if ( data.description && ! data.description_hidden ) { #>
<div class="description customize-section-description">
{{{ data.description }}}
</div>
<# } #>
</li>
</ul>
</li>
</pre><p class="wporg-dot-link-list"><a href="https://developer.wordpress.org/reference/files/wp-includes/class-wp-customize-section.php/">View all references</a> <a href="https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-includes/class-wp-customize-section.php#L20">View on Trac</a> <a href="https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-includes/class-wp-customize-section.php#L20-L405">View on GitHub</a></p></section>
<section class="wp-block-wporg-code-reference-related" data-nosnippet="true"><h2 id="related" class="is-toc-heading wp-block-heading has-heading-5-font-size" tabindex="-1" ><a href="#related">Related</a></h2> <section style="margin-top:var(--wp--preset--spacing--20)" class="wp-block-wporg-code-table" id="used-by"><figure class="wp-block-table "><table><thead><tr><th scope="col">Used by</th><th scope="col">Description</th></tr></thead><tbody><tr class=""><td><a href="https://developer.wordpress.org/reference/classes/wp_customize_nav_menu_section/">WP_Customize_Nav_Menu_Section</a><code>wp-includes/customize/class-wp-customize-nav-menu-section.php
Customize Menu Section Class
WP_Customize_New_Menu_Sectionwp-includes/customize/class-wp-customize-new-menu-section.php
Customize Menu Section Class
WP_Customize_Themes_Sectionwp-includes/customize/class-wp-customize-themes-section.php
Customize Themes Section class.
WP_Customize_Sidebar_Sectionwp-includes/customize/class-wp-customize-sidebar-section.php
Customizer section representing widget area (sidebar).
Changelog
| Version | Description |
|---|---|
| 3.4.0 | Introduced. |