WordPress 4.2.4-scripts
[autoinstalls/wordpress.git] / wp-includes / class-wp-customize-panel.php
index 8f85049dcbae5b56a09a53bc73c1fcec6e260fc8..ee9f846bc80e84780786b2d2230d1117bb13ed7f 100644 (file)
@@ -1,15 +1,43 @@
 <?php
 /**
- * Customize Panel Class.
- *
- * A UI container for sections, managed by the WP_Customize_Manager.
+ * WordPress Customize Panel classes
  *
  * @package WordPress
  * @subpackage Customize
  * @since 4.0.0
  */
+
+/**
+ * Customize Panel class.
+ *
+ * A UI container for sections, managed by the WP_Customize_Manager.
+ *
+ * @since 4.0.0
+ *
+ * @see WP_Customize_Manager
+ */
 class WP_Customize_Panel {
 
+       /**
+        * Incremented with each new class instantiation, then stored in $instance_number.
+        *
+        * Used when sorting two instances whose priorities are equal.
+        *
+        * @since 4.1.0
+        * @access protected
+        * @var int
+        */
+       protected static $instance_count = 0;
+
+       /**
+        * Order in which this instance was created in relation to other instances.
+        *
+        * @since 4.1.0
+        * @access public
+        * @var int
+        */
+       public $instance_number;
+
        /**
         * WP_Customize_Manager instance.
         *
@@ -82,6 +110,30 @@ class WP_Customize_Panel {
         */
        public $sections;
 
+       /**
+        * Type of this panel.
+        *
+        * @since 4.1.0
+        * @access public
+        * @var string
+        */
+       public $type = 'default';
+
+       /**
+        * Active callback.
+        *
+        * @since 4.1.0
+        * @access public
+        *
+        * @see WP_Customize_Section::active()
+        *
+        * @var callable Callback is called with one argument, the instance of
+        *               {@see 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.
         *
@@ -103,10 +155,68 @@ class WP_Customize_Panel {
 
                $this->manager = $manager;
                $this->id = $id;
+               if ( empty( $this->active_callback ) ) {
+                       $this->active_callback = array( $this, 'active_callback' );
+               }
+               self::$instance_count += 1;
+               $this->instance_number = self::$instance_count;
 
                $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.
+        */
+       final public 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   {@see WP_Customize_Panel} instance.
+                */
+               $active = apply_filters( 'customize_panel_active', $active, $panel );
+
+               return $active;
+       }
+
+       /**
+        * Default callback used when invoking {@see 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();
+               $array['instanceNumber'] = $this->instance_number;
+               return $array;
        }
 
        /**
@@ -117,7 +227,7 @@ class WP_Customize_Panel {
         *
         * @return bool False if theme doesn't support the panel or the 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;
                }
@@ -129,12 +239,27 @@ class WP_Customize_Panel {
                return true;
        }
 
+       /**
+        * Get the panel's content template for insertion into the Customizer pane.
+        *
+        * @since 4.1.0
+        *
+        * @return string Content for the panel.
+        */
+       final public function get_content() {
+               ob_start();
+               $this->maybe_render();
+               $template = trim( ob_get_contents() );
+               ob_end_clean();
+               return $template;
+       }
+
        /**
         * Check capabilities and render the panel.
         *
         * @since 4.0.0
         */
-       public final function maybe_render() {
+       final public function maybe_render() {
                if ( ! $this->check_capabilities() ) {
                        return;
                }
@@ -151,8 +276,8 @@ class WP_Customize_Panel {
                /**
                 * Fires before rendering a specific Customizer panel.
                 *
-                * The dynamic portion of the hook name, $this->id, refers to the ID
-                * of the specific Customizer panel to be rendered.
+                * The dynamic portion of the hook name, `$this->id`, refers to
+                * the ID of the specific Customizer panel to be rendered.
                 *
                 * @since 4.0.0
                 */
@@ -162,39 +287,47 @@ class WP_Customize_Panel {
        }
 
        /**
-        * Render the panel, and the sections that have been added to it.
+        * Render the panel container, and then its contents.
         *
         * @since 4.0.0
         * @access protected
         */
        protected function render() {
+               $classes = 'accordion-section control-section control-panel control-panel-' . $this->type;
                ?>
-               <li id="accordion-panel-<?php echo esc_attr( $this->id ); ?>" class="control-section control-panel accordion-section">
+               <li id="accordion-panel-<?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 open this panel' ); ?></span>
                        </h3>
                        <ul class="accordion-sub-container control-panel-content">
-                               <li class="accordion-section control-section<?php if ( empty( $this->description ) ) echo ' cannot-expand'; ?>">
-                                       <div class="accordion-section-title" tabindex="0">
-                                               <span class="preview-notice"><?php
-                                                       /* translators: %s is the site/panel title in the Customizer */
-                                                       echo sprintf( __( 'You are customizing %s' ), '<strong class="panel-title">' . esc_html( $this->title ) . '</strong>' );
-                                               ?></span>
-                                       </div>
-                                       <?php if ( ! empty( $this->description ) ) : ?>
-                                               <div class="accordion-section-content description">
-                                                       <?php echo $this->description; ?>
-                                               </div>
-                                       <?php endif; ?>
-                               </li>
-                               <?php
-                               foreach ( $this->sections as $section ) {
-                                       $section->maybe_render();
-                               }
-                               ?>
+                               <?php $this->render_content(); ?>
                        </ul>
                </li>
                <?php
        }
-}
\ No newline at end of file
+
+       /**
+        * Render the sections that have been added to the panel.
+        *
+        * @since 4.1.0
+        * @access protected
+        */
+       protected function render_content() {
+               ?>
+               <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
+                                       /* translators: %s is the site/panel title in the Customizer */
+                                       echo sprintf( __( 'You are customizing %s' ), '<strong class="panel-title">' . esc_html( $this->title ) . '</strong>' );
+                               ?></span>
+                       </div>
+                       <?php if ( ! empty( $this->description ) ) : ?>
+                               <div class="accordion-section-content description">
+                                       <?php echo $this->description; ?>
+                               </div>
+                       <?php endif; ?>
+               </li>
+               <?php
+       }
+}