mirror of
https://github.com/WordPress/WordPress.git
synced 2024-07-04 02:35:47 +02:00
0860bb2771
Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs. See #41452. Built from https://develop.svn.wordpress.org/trunk@41162 git-svn-id: http://core.svn.wordpress.org/trunk@41002 1a063a9b-81f0-0310-95a4-ce76da25c4cd
389 lines
9.6 KiB
PHP
389 lines
9.6 KiB
PHP
<?php
|
|
/**
|
|
* WordPress Customize Section classes
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Customize
|
|
* @since 3.4.0
|
|
*/
|
|
|
|
/**
|
|
* Customize Section class.
|
|
*
|
|
* A UI container for controls, managed by the WP_Customize_Manager class.
|
|
*
|
|
* @since 3.4.0
|
|
*
|
|
* @see WP_Customize_Manager
|
|
*/
|
|
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
|
|
*
|
|
* @static
|
|
* @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 integer
|
|
*/
|
|
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 feature support for the section.
|
|
*
|
|
* @since 3.4.0
|
|
* @var string|array
|
|
*/
|
|
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 An specific ID of the section.
|
|
* @param array $args Section arguments.
|
|
*/
|
|
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, and %s is the 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 && ! call_user_func_array( 'current_user_can', (array) $this->capability ) ) {
|
|
return false;
|
|
}
|
|
|
|
if ( $this->theme_supports && ! call_user_func_array( '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 $this 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; ?>">
|
|
<?php $this->render_template(); ?>
|
|
</script>
|
|
<?php
|
|
}
|
|
|
|
/**
|
|
* An Underscore (JS) template for rendering this section.
|
|
*
|
|
* Class variables for this section class are available in the `data` JS object;
|
|
* export custom variables by overriding WP_Customize_Section::json().
|
|
*
|
|
* @since 4.3.0
|
|
*
|
|
* @see WP_Customize_Section::print_template()
|
|
*/
|
|
protected function render_template() {
|
|
?>
|
|
<li id="accordion-section-{{ data.id }}" class="accordion-section control-section control-section-{{ data.type }}">
|
|
<h3 class="accordion-section-title" tabindex="0">
|
|
{{ data.title }}
|
|
<span class="screen-reader-text"><?php _e( 'Press return or enter to open this section' ); ?></span>
|
|
</h3>
|
|
<ul class="accordion-section-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"><?php _e( 'Back' ); ?></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"><?php _e( 'Help' ); ?></span></button>
|
|
<div class="description customize-section-description">
|
|
{{{ data.description }}}
|
|
</div>
|
|
<# } #>
|
|
</div>
|
|
|
|
<# if ( data.description && ! data.description_hidden ) { #>
|
|
<div class="description customize-section-description">
|
|
{{{ data.description }}}
|
|
</div>
|
|
<# } #>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<?php
|
|
}
|
|
}
|
|
|
|
/** WP_Customize_Themes_Section class */
|
|
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-themes-section.php' );
|
|
|
|
/** WP_Customize_Sidebar_Section class */
|
|
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-sidebar-section.php' );
|
|
|
|
/** WP_Customize_Nav_Menu_Section class */
|
|
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-section.php' );
|
|
|
|
/** WP_Customize_New_Menu_Section class */
|
|
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-section.php' );
|