Ticket #29758: 29758.php.diff

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

@@ -83 +83 @@
         public $sections;
 
         /**
+         * Callback.
+         *
+         * @since 4.1.0
+         * @access public
+         *
+         * @see WP_Customize_Panel::active()
+         *
+         * @var callable Callback is called with one argument, the instance of
+         *               WP_Customize_Panel, and returns bool to indicate whether
+         *               the panel is active (such as it relates to the URL
+         *               currently being previewed).
+         */
+        public $active_callback = '';
+
+        /**
          * Constructor.
          *
          * Any supplied $args override class property defaults.
@@ -103 +118 @@
 
                 $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.
 
@@ -110 +128 @@
         }
 
         /**
+         * 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;
+        }
+
+        // @todo once JS API is in place: $this->json['active'] = $this->active();
+
+        /**
          * Checks required user capabilities and whether the theme has the
          * feature support required by the panel.
          *

src/wp-includes/class-wp-customize-section.php

@@ -92 +92 @@
         public $controls;
 
         /**
+         * 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 secyion is active (such as it relates to the URL
+         *               currently being previewed).
+         */
+        public $active_callback = '';
+
+        /**
          * Constructor.
          *
          * Any supplied $args override class property defaults.
@@ -112 +127 @@
                 $this->manager = $manager;
                 $this->id = $id;
 
+                if ( empty( $this->active_callback ) ) {
+                        $this->active_callback = array( $this, 'active_callback' );
+                }
+
                 $this->controls = array(); // Users cannot customize the $controls array.
 
                 return $this;
@@ -118 +137 @@
         }
 
         /**
+         * 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.
+         */
+        public final function active() {
+                $section = $this;
+                $active = call_user_func( $this->active_callback, $this );
+
+                /**
+                 * Filter response of WP_Customize_Section::active().
+                 *
+                 * @since 4.1.0
+                 *
+                 * @param bool                 $active  Whether the Customizer section is active.
+                 * @param WP_Customize_Section $section WP_Customize_Section instance.
+                 */
+                $active = apply_filters( 'customize_section_active', $active, $section );
+
+                return $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 bool Always true.
+         */
+        public function active_callback() {
+                return true;
+        }
+
+        // @todo once JS API is in place: $this->json['active'] = $this->active();
+
+        /**
          * Checks required user capabilities and whether the theme has the
          * feature support required by the section.
          *