enmi-conf.org: comparison wp/wp-includes/class-wp-customize-section.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 	 * Incremented with each new class instantiation, then stored in $instance_number.
 	 *
 	 * Used when sorting two instances whose priorities are equal.
 	 *
 	 * @since 4.1.0
-	 * @access protected
+	 *
+	 * @static
 	 * @var int
 	 */
 	protected static $instance_count = 0;
 	/**
 	 * Order in which this instance was created in relation to other instances.
 	 *
 	 * @since 4.1.0
-	 * @access public
 	 * @var int
 	 */
 	public $instance_number;
 	/**
 	 * WP_Customize_Manager instance.
 	 *
 	 * @since 3.4.0
-	 * @access public
 	 * @var WP_Customize_Manager
 	 */
 	public $manager;
 	/**
 	 * Unique identifier.
 	 *
 	 * @since 3.4.0
-	 * @access public
 	 * @var string
 	 */
 	public $id;
 	/**
 	 * Priority of the section which informs load order of sections.
 	 *
 	 * @since 3.4.0
-	 * @access public
 	 * @var integer
 	 */
 	public $priority = 160;
 	/**
 	 * Panel in which to show the section, making it a sub-section.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 * @var string
 	 */
 	public $panel = '';
 	/**
 	 * Capability required for the section.
 	 *
 	 * @since 3.4.0
-	 * @access public
 	 * @var string
 	 */
 	public $capability = 'edit_theme_options';
 	/**
 	 * Theme feature support for the section.
 	 *
 	 * @since 3.4.0
-	 * @access public
 	 * @var string|array
 	 */
 	public $theme_supports = '';
 	/**
 	 * Title of the section to show in UI.
 	 *
 	 * @since 3.4.0
-	 * @access public
 	 * @var string
 	 */
 	public $title = '';
 	/**
 	 * Description to show in the UI.
 	 *
 	 * @since 3.4.0
-	 * @access public
 	 * @var string
 	 */
 	public $description = '';
 	/**
 	 * Customizer controls for this section.
 	 *
 	 * @since 3.4.0
-	 * @access public
 	 * @var array
 	 */
 	public $controls;
 	/**
 	 * Type of this section.
 	 *
 	 * @since 4.1.0
-	 * @access public
 	 * @var string
 	 */
 	public $type = 'default';
 	/**
 	 * Active callback.
 	 *
 	 * @since 4.1.0
-	 * @access public
 	 *
 	 * @see WP_Customize_Section::active()
 	 *
 	 * @var callable Callback is called with one argument, the instance of
-	 *               {@see WP_Customize_Section}, and returns bool to indicate
+	 *               WP_Customize_Section, and returns bool to indicate whether
-	 *               whether the section is active (such as it relates to the URL
+	 *               the section is active (such as it relates to the URL currently
-	 *               currently being previewed).
+	 *               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.
 	/**
 	 * Check whether section is active to current Customizer preview.
 	 *
 	 * @since 4.1.0
-	 * @access public
 	 *
 	 * @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 );
 		/**
-		 * Filter response of {@see WP_Customize_Section::active()}.
+		 * 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 {@see WP_Customize_Section} instance.
+		 * @param WP_Customize_Section $section WP_Customize_Section instance.
 		 */
 		$active = apply_filters( 'customize_section_active', $active, $section );
 		return $active;
 	}
 	/**
-	 * Default callback used when invoking {@see WP_Customize_Section::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
-	 * @access public
+	 *
-	 *
+	 * @return true Always true.
-	 * @return bool Always true.
 	 */
 	public function active_callback() {
 		return true;
 	}
 	 * @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( 'title', 'description', 'priority', 'panel', 'type' ) );
+		$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: &#9656; is the unicode right-pointing triangle, and %s is the section title in the Customizer */
+			$array['customizeAction'] = sprintf( __( 'Customizing &#9656; %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
 		return true;
 	}
 	/**
-	 * Get the section's content template for insertion into the Customizer pane.
+	 * 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();
-		$template = trim( ob_get_contents() );
+		return trim( ob_get_clean() );
-		ob_end_clean();
-		return $template;
 	}
 	/**
 	 * Check capabilities and render the section.
 	 *
 		$this->render();
 	}
 	/**
-	 * Render the section, and the controls that have been added to it.
+	 * Render the section UI in a subclass.
 	 *
-	 * @since 3.4.0
+	 * Sections are now rendered in JS by default, see WP_Customize_Section::print_template().
-	 */
+	 *
-	protected function render() {
+	 * @since 3.4.0
-		$classes = 'accordion-section control-section control-section-' . $this->type;
+	 */
+	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() {
 		?>
-		<li id="accordion-section-<?php echo esc_attr( $this->id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
+		<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">
-				<?php echo esc_html( $this->title ); ?>
+				{{ data.title }}
-				<span class="screen-reader-text"><?php _e( 'Press return or enter to expand' ); ?></span>
+				<span class="screen-reader-text"><?php _e( 'Press return or enter to open this section' ); ?></span>
 			</h3>
 			<ul class="accordion-section-content">
-				<?php if ( ! empty( $this->description ) ) : ?>
+				<li class="customize-section-description-container section-meta <# if ( data.description_hidden ) { #>customize-info<# } #>">
-					<li class="customize-section-description-container">
+					<div class="customize-section-title">
-						<p class="description customize-section-description"><?php echo $this->description; ?></p>
+						<button class="customize-section-back" tabindex="-1">
-					</li>
+							<span class="screen-reader-text"><?php _e( 'Back' ); ?></span>
-				<?php endif; ?>
+						</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 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>
 		<?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' );
 /**
-* Customize Themes Section class.
+* WP_Customize_New_Menu_Section class
 *
-* A UI container for theme controls, which behaves like a backwards Panel.
+* As this file is deprecated, it will trigger a deprecation notice if instantiated. In a subsequent
-*
+* release, the require_once() here will be removed and _deprecated_file() will be called if file is
-* @since 4.2.0
+* required at all.
 *
-* @see WP_Customize_Section
+* @deprecated 4.9.0 This file is no longer used due to new menu creation UX.
 */
-class WP_Customize_Themes_Section extends WP_Customize_Section {
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-section.php' );
-	/**
-	 * Customize section type.
-	 *
-	 * @since 4.2.0
-	 * @access public
-	 * @var string
-	 */
-	public $type = 'themes';
-	/**
-	 * Render the themes section, which behaves like a panel.
-	 *
-	 * @since 4.2.0
-	 * @access protected
-	 */
-	protected function render() {
-		$classes = 'accordion-section control-section control-section-' . $this->type;
-		?>
-		<li id="accordion-section-<?php echo esc_attr( $this->id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
-			<h3 class="accordion-section-title">
-				<?php
-				if ( $this->manager->is_theme_active() ) {
-					/* translators: %s: theme name */
-					printf( __( '<span>Active theme</span> %s' ), $this->title );
-				} else {
-					/* translators: %s: theme name */
-					printf( __( '<span>Previewing theme</span> %s' ), $this->title );
-				}
-				?>
-				<button type="button" class="button change-theme"><?php _ex( 'Change', 'theme' ); ?></button>
-			</h3>
-			<div class="customize-themes-panel control-panel-content themes-php">
-				<h2>
-					<?php _e( 'Themes' ); ?>
-					<span class="title-count theme-count"><?php echo count( $this->controls ) + 1 /* Active theme */; ?></span>
-				</h2>
-				<h3 class="accordion-section-title customize-section-title">
-					<?php
-					if ( $this->manager->is_theme_active() ) {
-						/* translators: %s: theme name */
-						printf( __( '<span>Active theme</span> %s' ), $this->title );
-					} else {
-						/* translators: %s: theme name */
-						printf( __( '<span>Previewing theme</span> %s' ), $this->title );
-					}
-					?>
-					<button type="button" class="button customize-theme"><?php _e( 'Customize' ); ?></button>
-				</h3>
-				<div class="theme-overlay" tabindex="0" role="dialog" aria-label="<?php esc_attr_e( 'Theme Details' ); ?>"></div>
-				<div id="customize-container"></div>
-				<?php if ( count( $this->controls ) > 4 ) : ?>
-					<p><label for="themes-filter">
-						<span class="screen-reader-text"><?php _e( 'Search installed themes...' ); ?></span>
-						<input type="text" id="themes-filter" placeholder="<?php esc_attr_e( 'Search installed themes...' ); ?>" />
-					</label></p>
-				<?php endif; ?>
-				<div class="theme-browser rendered">
-					<ul class="themes accordion-section-content">
-					</ul>
-				</div>
-			</div>
-		</li>
-<?php }
-}
-/**
-* Customizer section representing widget area (sidebar).
-*
-* @since 4.1.0
-*
-* @see WP_Customize_Section
-*/
-class WP_Customize_Sidebar_Section extends WP_Customize_Section {
-	/**
-	 * Type of this section.
-	 *
-	 * @since 4.1.0
-	 * @access public
-	 * @var string
-	 */
-	public $type = 'sidebar';
-	/**
-	 * Unique identifier.
-	 *
-	 * @since 4.1.0
-	 * @access public
-	 * @var string
-	 */
-	public $sidebar_id;
-	/**
-	 * 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() {
-		$json = parent::json();
-		$json['sidebarId'] = $this->sidebar_id;
-		return $json;
-	}
-	/**
-	 * Whether the current sidebar is rendered on the page.
-	 *
-	 * @since 4.1.0
-	 * @access public
-	 *
-	 * @return bool Whether sidebar is rendered.
-	 */
-	public function active_callback() {
-		return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
-	}
-}

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9