Changeset 28861 for trunk/src/wp-includes/class-wp-customize-manager.php

Timestamp:

06/26/2014 08:16:21 PM (12 years ago)

Author:

ocean90

Message:

Customizer: Introduce a "panel" API to organize multiple sections into a one section.

Create a panel via $GLOBALS['wp_customize']->add_panel( $panel_id, $args ) and use $panel_id for the panel argument in $GLOBALS['wp_customize']->add_section( $section_id, $args ). That's it.
As an example all widget area sections are now summarized into one panel. Feedback appreciated.

props celloexpressions.
see #27406.

Location:

trunk/src

Files:

• . (modified) (1 prop)
• wp-includes/class-wp-customize-manager.php (modified) (6 diffs)

trunk/src

@@ -1 +1 @@
 .wp-tests-version
 .htaccess
+web-store-experiences

@@ -1 +1 @@
 .wp-tests-version
 .htaccess
+web-store-experiences

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

@@ -46 +46 @@
 
         protected $settings = array();
+        protected $panels   = array();
         protected $sections = array();
         protected $controls = array();
@@ -313 +314 @@
         public function sections() {
                 return $this->sections;
+        }
+
+        /**
+         * Get the registered panels.
+         *
+         * @since 4.0.0
+         *
+         * @return array
+         */
+        public function panels() {
+                return $this->panels;
         }
 
@@ -649 +661 @@
 
         /**
+         * Add a customize panel.
+         *
+         * @since 4.0.0
+         *
+         * @param WP_Customize_Panel|string $id   Customize Panel object, or Panel ID.
+         * @param array                     $args Panel arguments.
+         */
+        public function add_panel( $id, $args = array() ) {
+                if ( is_a( $id, 'WP_Customize_Panel' ) ) {
+                        $panel = $id;
+                }
+                else {
+                        $panel = new WP_Customize_Panel( $this, $id, $args );
+                }
+
+                $this->panels[ $panel->id ] = $panel;
+        }
+
+        /**
+         * Retrieve a customize panel.
+         *
+         * @since 4.0.0
+         *
+         * @param string $id Panel ID.
+         * @return WP_Customize_Panel
+         */
+        public function get_panel( $id ) {
+                if ( isset( $this->panels[ $id ] ) ) {
+                        return $this->panels[ $id ];
+                }
+        }
+
+        /**
+         * Remove a customize panel.
+         *
+         * @since 4.0.0
+         *
+         * @param string $id Panel ID.
+         */
+        public function remove_panel( $id ) {
+                unset( $this->panels[ $id ] );
+        }
+
+        /**
          * Add a customize section.
          *
@@ -750 +806 @@
 
         /**
-         * Prepare settings and sections.
+         * Prepare panels, sections, and controls.
          *
          * For each, check if required related components exist,
@@ -764 +820 @@
 
                 foreach ( $this->controls as $id => $control ) {
-                        if ( ! isset( $this->sections[ $control->section ] ) || ! $control->check_capabilities() )
+                        if ( ! isset( $this->sections[ $control->section ] ) || ! $control->check_capabilities() ) {
                                 continue;
+                        }
 
                         $this->sections[ $control->section ]->controls[] = $control;
@@ -779 +836 @@
 
                 foreach ( $this->sections as $section ) {
-                        if ( ! $section->check_capabilities() || ! $section->controls )
+                        if ( ! $section->check_capabilities() || ! $section->controls ) {
                                 continue;
+                        }
 
                         usort( $section->controls, array( $this, '_cmp_priority' ) );
-                        $sections[] = $section;
+
+                        if ( ! $section->panel ) {
+                                // Top-level section.
+                                $sections[] = $section;
+                        } else {
+                                // This section belongs to a panel.
+                                if ( isset( $this->panels [ $section->panel ] ) ) {
+                                        $this->panels[ $section->panel ]->sections[] = $section;
+                                }
+                        }
                 }
                 $this->sections = $sections;
+
+                // Prepare panels.
+                // Reversing makes uasort sort by time added when conflicts occur.
+                $this->panels = array_reverse( $this->panels );
+                uasort( $this->panels, array( $this, '_cmp_priority' ) );
+                $panels = array();
+
+                foreach ( $this->panels as $panel ) {
+                        if ( ! $panel->check_capabilities() || ! $panel->sections ) {
+                                continue;
+                        }
+
+                        usort( $panel->sections, array( $this, '_cmp_priority' ) );
+                        $panels[] = $panel;
+                }
+                $this->panels = $panels;
         }
 

@@ -1 +1 @@
 .wp-tests-version
 .htaccess
+web-store-experiences