Changeset 30102 for trunk/src/wp-includes/class-wp-customize-panel.php

Timestamp:

10/29/2014 10:50:21 PM (12 years ago)

Author:

ocean90

Message:

Improve/introduce Customizer JavaScript models for Controls, Sections, and Panels.

• Introduce models for panels and sections.
• Introduce API to expand and focus a control, section or panel.
• Allow deep-linking to panels, sections, and controls inside of the Customizer.
• Clean up accordion.js, removing all Customizer-specific logic.
• Add initial unit tests for wp.customize.Class in customize-base.js.

​https://make.wordpress.org/core/2014/10/27/toward-a-complete-javascript-api-for-the-customizer/ provides an overview of how to use the JavaScript API.

props westonruter, celloexpressions, ryankienstra.
see #28032, #28579, #28580, #28650, #28709, #29758.
fixes #29529.

File:

• trunk/src/wp-includes/class-wp-customize-panel.php (modified) (5 diffs)

trunk/src/wp-includes/class-wp-customize-panel.php

@@ -84 +84 @@
 
         /**
+         * @since 4.1.0
+         * @access public
+         * @var string
+         */
+        public $type;
+
+        /**
+         * Callback.
+         *
+         * @since 4.1.0
+         * @access public
+         *
+         * @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 = '';
+
+        /**
          * Constructor.
          *
@@ -104 +126 @@
                 $this->manager = $manager;
                 $this->id = $id;
+                if ( empty( $this->active_callback ) ) {
+                        $this->active_callback = array( $this, 'active_callback' );
+                }
 
                 $this->sections = array(); // Users cannot customize the $sections array.
 
                 return $this;
+        }
+
+        /**
+         * 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.
+         */
+        public final function active() {
+                $panel = $this;
+                $active = call_user_func( $this->active_callback, $this );
+
+                /**
+                 * Filter response of WP_Customize_Panel::active().
+                 *
+                 * @since 4.1.0
+                 *
+                 * @param bool                 $active  Whether the Customizer panel is active.
+                 * @param WP_Customize_Panel $panel WP_Customize_Panel instance.
+                 */
+                $active = apply_filters( 'customize_panel_active', $active, $panel );
+
+                return $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;
+        }
+
+        /**
+         * 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( 'title', 'description', 'priority', 'type' ) );
+                $array['content'] = $this->get_content();
+                $array['active'] = $this->active();
+                return $array;
         }
 
@@ -128 +207 @@
 
                 return true;
+        }
+
+        /**
+         * Get the panel's content template for insertion into the Customizer pane.
+         *
+         * @since 4.1.0
+         *
+         * @return string
+         */
+        public final function get_content() {
+                ob_start();
+                $this->maybe_render();
+                $template = trim( ob_get_contents() );
+                ob_end_clean();
+                return $template;
         }
 
@@ -190 +284 @@
         protected function render_content() {
                 ?>
-                <li class="accordion-section control-section<?php if ( empty( $this->description ) ) echo ' cannot-expand'; ?>">
+                <li class="panel-meta accordion-section control-section<?php if ( empty( $this->description ) ) { echo ' cannot-expand'; } ?>">
                         <div class="accordion-section-title" tabindex="0">
                                 <span class="preview-notice"><?php
@@ -204 +298 @@
                 </li>
                 <?php
-                foreach ( $this->sections as $section ) {
-                        $section->maybe_render();
-                }
         }
 }