WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / class-wp-customize-section.php
index b033203e7fa9394ebeefbb8d86e8d4fe51970161..81f3ced7501d3d40593c9b4bd6be747f71b6981b 100644 (file)
@@ -1,13 +1,21 @@
 <?php
 /**
- * Customize Section Class.
- *
- * A UI container for controls, managed by the WP_Customize_Manager.
+ * 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 {
 
        /**
@@ -16,6 +24,8 @@ class WP_Customize_Section {
         * Used when sorting two instances whose priorities are equal.
         *
         * @since 4.1.0
+        *
+        * @static
         * @access protected
         * @var int
         */
@@ -163,8 +173,6 @@ class WP_Customize_Section {
                $this->instance_number = self::$instance_count;
 
                $this->controls = array(); // Users cannot customize the $controls array.
-
-               return $this;
        }
 
        /**
@@ -175,7 +183,7 @@ class WP_Customize_Section {
         *
         * @return bool Whether the section is active to the current preview.
         */
-       public final function active() {
+       final public function active() {
                $section = $this;
                $active = call_user_func( $this->active_callback, $this );
 
@@ -201,7 +209,7 @@ class WP_Customize_Section {
         * @since 4.1.0
         * @access public
         *
-        * @return bool Always true.
+        * @return true Always true.
         */
        public function active_callback() {
                return true;
@@ -215,10 +223,19 @@ class WP_Customize_Section {
         * @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' ) );
+               $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;
        }
 
@@ -230,7 +247,7 @@ class WP_Customize_Section {
         *
         * @return bool False if theme doesn't support the section or user doesn't have the capability.
         */
-       public final function check_capabilities() {
+       final public function check_capabilities() {
                if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) ) {
                        return false;
                }
@@ -243,18 +260,16 @@ class WP_Customize_Section {
        }
 
        /**
-        * 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.
         */
-       public final function get_content() {
+       final public function get_content() {
                ob_start();
                $this->maybe_render();
-               $template = trim( ob_get_contents() );
-               ob_end_clean();
-               return $template;
+               return trim( ob_get_clean() );
        }
 
        /**
@@ -262,7 +277,7 @@ class WP_Customize_Section {
         *
         * @since 3.4.0
         */
-       public final function maybe_render() {
+       final public function maybe_render() {
                if ( ! $this->check_capabilities() ) {
                        return;
                }
@@ -289,82 +304,84 @@ class WP_Customize_Section {
        }
 
        /**
-        * Render the section, and the controls that have been added to it.
+        * Render the section UI in a subclass.
+        *
+        * Sections are now rendered in JS by default, see {@see WP_Customize_Section::print_template()}.
         *
         * @since 3.4.0
         */
-       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" tabindex="0">
-                               <?php echo esc_html( $this->title ); ?>
-                               <span class="screen-reader-text"><?php _e( 'Press return or enter to expand' ); ?></span>
-                       </h3>
-                       <ul class="accordion-section-content">
-                               <?php if ( ! empty( $this->description ) ) : ?>
-                                       <li class="customize-section-description-container">
-                                               <p class="description customize-section-description"><?php echo $this->description; ?></p>
-                                       </li>
-                               <?php endif; ?>
-                       </ul>
-               </li>
-               <?php
-       }
-}
-
-/**
- * Customizer section representing widget area (sidebar).
- *
- * @package WordPress
- * @subpackage Customize
- *
- * @since 4.1.0
- *
- * @see WP_Customize_Section
- */
-class WP_Customize_Sidebar_Section extends WP_Customize_Section {
+       protected function render() {}
 
        /**
-        * Type of this section.
+        * Render the section's JS template.
         *
-        * @since 4.1.0
-        * @access public
-        * @var string
-        */
-       public $type = 'sidebar';
-
-       /**
-        * Unique identifier.
+        * This function is only run for section types that have been registered with
+        * WP_Customize_Manager::register_section_type().
         *
-        * @since 4.1.0
+        * @since 4.3.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.
+        * @see WP_Customize_Manager::render_template()
         */
-       public function json() {
-               $json = parent::json();
-               $json['sidebarId'] = $this->sidebar_id;
-               return $json;
+       public function print_template() {
+        ?>
+               <script type="text/html" id="tmpl-customize-section-<?php echo $this->type; ?>">
+                       <?php $this->render_template(); ?>
+               </script>
+        <?php
        }
 
        /**
-        * Whether the current sidebar is rendered on the page.
+        * An Underscore (JS) template for rendering this section.
         *
-        * @since 4.1.0
-        * @access public
+        * 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
+        * @access protected
         *
-        * @return bool Whether sidebar is rendered.
+        * @see WP_Customize_Section::print_template()
         */
-       public function active_callback() {
-               return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
+       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">
+                                       <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>
+                                       </div>
+                                       <# if ( data.description ) { #>
+                                               <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' );