enmi-conf.org: comparison wp/wp-includes/class-wp-customize-panel.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 4.0.0
-	 * @access public
 	 * @var WP_Customize_Manager
 	 */
 	public $manager;
 	/**
 	 * Unique identifier.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 * @var string
 	 */
 	public $id;
 	/**
 	 * Priority of the panel, defining the display order of panels and sections.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 * @var integer
 	 */
 	public $priority = 160;
 	/**
 	 * Capability required for the panel.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 * @var string
 	 */
 	public $capability = 'edit_theme_options';
 	/**
 	 * Theme feature support for the panel.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 * @var string|array
 	 */
 	public $theme_supports = '';
 	/**
 	 * Title of the panel to show in UI.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 * @var string
 	 */
 	public $title = '';
 	/**
 	 * Description to show in the UI.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 * @var string
 	 */
 	public $description = '';
 	/**
+	 * Auto-expand a section in a panel when the panel is expanded when the panel only has the one section.
+	 *
+	 * @since 4.7.4
+	 * @var bool
+	 */
+	public $auto_expand_sole_section = false;
+	/**
 	 * Customizer sections for this panel.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 * @var array
 	 */
 	public $sections;
 	/**
 	 * Type of this panel.
 	 *
 	 * @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 = '';
 	/**
 	 * Constructor.
 	/**
 	 * Check whether panel is active to current Customizer preview.
 	 *
 	 * @since 4.1.0
-	 * @access public
 	 *
 	 * @return bool Whether the panel is active to the current preview.
 	 */
 	final public function active() {
 		$panel = $this;
 		$active = call_user_func( $this->active_callback, $this );
 		/**
-		 * Filter response of WP_Customize_Panel::active().
+		 * Filters response of WP_Customize_Panel::active().
 		 *
 		 * @since 4.1.0
 		 *
-		 * @param bool               $active  Whether the Customizer panel is active.
+		 * @param bool               $active Whether the Customizer panel is active.
-		 * @param WP_Customize_Panel $panel   {@see WP_Customize_Panel} instance.
+		 * @param WP_Customize_Panel $panel  WP_Customize_Panel instance.
 		 */
 		$active = apply_filters( 'customize_panel_active', $active, $panel );
 		return $active;
 	}
 	/**
-	 * Default callback used when invoking {@see WP_Customize_Panel::active()}.
+	 * Default callback used when invoking WP_Customize_Panel::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 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', 'type' ) );
+		$array = wp_array_slice_assoc( (array) $this, array( 'id', 'description', 'priority', 'type' ) );
+		$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;
+		$array['autoExpandSoleSection'] = $this->auto_expand_sole_section;
 		return $array;
 	}
 	/**
 	 * Checks required user capabilities and whether the theme has the
 	 * @return string Content for the panel.
 	 */
 	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 panel.
 	 *
 		$this->render();
 	}
 	/**
-	 * Render the panel container, and then its contents.
+	 * Render the panel container, and then its contents (via `this->render_content()`) in a subclass.
 	 *
-	 * @since 4.0.0
+	 * Panel containers are now rendered in JS by default, see WP_Customize_Panel::print_template().
-	 * @access protected
+	 *
-	 */
+	 * @since 4.0.0
-	protected function render() {
+	 */
-		$classes = 'accordion-section control-section control-panel control-panel-' . $this->type;
+	protected function render() {}
+	/**
+	 * Render the panel UI in a subclass.
+	 *
+	 * Panel contents are now rendered in JS by default, see WP_Customize_Panel::print_template().
+	 *
+	 * @since 4.1.0
+	 */
+	protected function render_content() {}
+	/**
+	 * Render the panel's JS templates.
+	 *
+	 * This function is only run for panel types that have been registered with
+	 * WP_Customize_Manager::register_panel_type().
+	 *
+	 * @since 4.3.0
+	 *
+	 * @see WP_Customize_Manager::register_panel_type()
+	 */
+	public function print_template() {
 		?>
-		<li id="accordion-panel-<?php echo esc_attr( $this->id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
+		<script type="text/html" id="tmpl-customize-panel-<?php echo esc_attr( $this->type ); ?>-content">
+			<?php $this->content_template(); ?>
+		</script>
+		<script type="text/html" id="tmpl-customize-panel-<?php echo esc_attr( $this->type ); ?>">
+			<?php $this->render_template(); ?>
+		</script>
+<?php
+	}
+	/**
+	 * An Underscore (JS) template for rendering this panel's container.
+	 *
+	 * Class variables for this panel class are available in the `data` JS object;
+	 * export custom variables by overriding WP_Customize_Panel::json().
+	 *
+	 * @see WP_Customize_Panel::print_template()
+	 *
+	 * @since 4.3.0
+	 */
+	protected function render_template() {
+		?>
+		<li id="accordion-panel-{{ data.id }}" class="accordion-section control-section control-panel control-panel-{{ 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 open this panel' ); ?></span>
 			</h3>
-			<ul class="accordion-sub-container control-panel-content">
+			<ul class="accordion-sub-container control-panel-content"></ul>
-				<?php $this->render_content(); ?>
-			</ul>
 		</li>
 		<?php
 	}
 	/**
-	 * Render the sections that have been added to the panel.
+	 * An Underscore (JS) template for this panel's content (but not its container).
 	 *
-	 * @since 4.1.0
+	 * Class variables for this panel class are available in the `data` JS object;
-	 * @access protected
+	 * export custom variables by overriding WP_Customize_Panel::json().
-	 */
+	 *
-	protected function render_content() {
+	 * @see WP_Customize_Panel::print_template()
+	 *
+	 * @since 4.3.0
+	 */
+	protected function content_template() {
 		?>
-		<li class="panel-meta accordion-section control-section<?php if ( empty( $this->description ) ) { echo ' cannot-expand'; } ?>">
+		<li class="panel-meta customize-info accordion-section <# if ( ! data.description ) { #> cannot-expand<# } #>">
-			<div class="accordion-section-title" tabindex="0">
+			<button class="customize-panel-back" tabindex="-1"><span class="screen-reader-text"><?php _e( 'Back' ); ?></span></button>
+			<div class="accordion-section-title">
 				<span class="preview-notice"><?php
-					/* translators: %s is the site/panel title in the Customizer */
+					/* translators: %s: the site/panel title in the Customizer */
-					echo sprintf( __( 'You are customizing %s' ), '<strong class="panel-title">' . esc_html( $this->title ) . '</strong>' );
+					echo sprintf( __( 'You are customizing %s' ), '<strong class="panel-title">{{ data.title }}</strong>' );
 				?></span>
+				<# if ( data.description ) { #>
+					<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>
-			<?php if ( ! empty( $this->description ) ) : ?>
+			<# if ( data.description ) { #>
-				<div class="accordion-section-content description">
+				<div class="description customize-panel-description">
-					<?php echo $this->description; ?>
+					{{{ data.description }}}
 				</div>
-			<?php endif; ?>
+			<# } #>
+			<div class="customize-control-notifications-container"></div>
 		</li>
 		<?php
 	}
 }
+/** WP_Customize_Nav_Menus_Panel class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menus-panel.php' );

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9