Changeset 29051 for trunk/src/wp-includes/class-wp-customize-control.php

Timestamp:

07/09/2014 11:57:29 PM (12 years ago)

Author:

SergeyBiryukov

Message:

Customizer: Introduce WP_Customize_Control::active() method to determine whether the control is relevant to the current context (i.e. to the current URL being previewed).

Control can indicate its active state by a subclass overriding the 'active_callback' method, by supplying a callable 'active_callback' argument into the control's constructor, or by filtering 'customize_control_active'.

props westonruter.
see #27993.

File:

• trunk/src/wp-includes/class-wp-customize-control.php (modified) (8 diffs)

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

@@ -86 +86 @@
         public $type = 'text';
 
+        /**
+         * Callback
+         *
+         * @since 4.0.0
+         *
+         * @access public
+         * @see WP_Customize_Control::active()
+         * @var callable  Callback is called with one argument, the instance of
+         *                WP_Customize_Control, and returns bool to indicate whether
+         *                the control is active (such as it relates to the URL
+         *                currently being previewed).
+         */
+        public $active_callback = '';
 
         /**
@@ -103 +116 @@
                 $keys = array_keys( get_object_vars( $this ) );
                 foreach ( $keys as $key ) {
-                        if ( isset( $args[ $key ] ) )
+                        if ( isset( $args[ $key ] ) ) {
                                 $this->$key = $args[ $key ];
+                        }
                 }
 
                 $this->manager = $manager;
                 $this->id = $id;
+                if ( empty( $this->active_callback ) ) {
+                        $this->active_callback = array( $this, 'active_callback' );
+                }
 
                 // Process settings.
-                if ( empty( $this->settings ) )
+                if ( empty( $this->settings ) ) {
                         $this->settings = $id;
+                }
 
                 $settings = array();
@@ -133 +151 @@
         public function enqueue() {}
 
+        /**
+         * Check whether control is active to current customizer preview.
+         *
+         * @since 4.0.0
+         *
+         * @return bool
+         */
+        public final function active() {
+                $control = $this;
+                $active = call_user_func( $this->active_callback, $this );
+
+                /**
+                 * Filter response of WP_Customize_Control::active().
+                 *
+                 * @since 4.0.0
+                 *
+                 * @param bool $active
+                 * @param WP_Customize_Control $control
+                 */
+                $active = apply_filters( 'customize_control_active', $active, $control );
+
+                return $active;
+        }
+
+        /**
+         * Default callback used when invoking WP_Customize_Control::active().
+         *
+         * Subclasses can override this with their specific logic, or they may
+         * provide an 'active_callback' argument to the constructor.
+         *
+         * @return bool
+         */
+        public function active_callback() {
+                return true;
+        }
 
         /**
@@ -144 +197 @@
          */
         public final function value( $setting_key = 'default' ) {
-                if ( isset( $this->settings[ $setting_key ] ) )
+                if ( isset( $this->settings[ $setting_key ] ) ) {
                         return $this->settings[ $setting_key ]->value();
+                }
         }
 
@@ -160 +214 @@
 
                 $this->json['type'] = $this->type;
+                $this->json['active'] = $this->active();
         }
 
@@ -257 +312 @@
         }
 
-        /**
+        /**
          * Render the custom attributes for the control's input element.
          *
@@ -996 +1051 @@
                 <?php
         }
+
+        /**
+         * @return bool
+         */
+        function active_callback() {
+                return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
+        }
 }
 
@@ -1036 +1098 @@
                 echo $this->manager->widgets->get_widget_control( $args );
         }
+
+        /**
+         * @return bool
+         */
+        function active_callback() {
+                return $this->manager->widgets->is_widget_rendered( $this->widget_id );
+        }
 }