]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/class-wp-customize-section.php
WordPress 4.7
[autoinstalls/wordpress.git] / wp-includes / class-wp-customize-section.php
index 7f2d52c6bc1fd8ca9452a47ff26a541a663e5f98..68d677133ee95bd61df26f908d2db25119e2220c 100644 (file)
@@ -139,12 +139,24 @@ class WP_Customize_Section {
         * @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).
+        *               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 = '';
 
+       /**
+        * Show the description or hide it behind the help icon.
+        *
+        * @since 4.7.0
+        * @access public
+        *
+        * @var bool Indicates whether the Section's description should be
+        *           hidden behind a help icon ("?") in the Section header,
+        *           similar to how help icons are displayed on Panels.
+        */
+       public $description_hidden = false;
+
        /**
         * Constructor.
         *
@@ -188,12 +200,12 @@ class WP_Customize_Section {
                $active = call_user_func( $this->active_callback, $this );
 
                /**
-                * Filter response of {@see WP_Customize_Section::active()}.
+                * Filters response of WP_Customize_Section::active().
                 *
                 * @since 4.1.0
                 *
                 * @param bool                 $active  Whether the Customizer section is active.
-                * @param WP_Customize_Section $section {@see WP_Customize_Section} instance.
+                * @param WP_Customize_Section $section WP_Customize_Section instance.
                 */
                $active = apply_filters( 'customize_section_active', $active, $section );
 
@@ -201,7 +213,7 @@ class WP_Customize_Section {
        }
 
        /**
-        * Default callback used when invoking {@see WP_Customize_Section::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.
@@ -223,7 +235,7 @@ class WP_Customize_Section {
         * @return array The array to be exported to the client as JSON.
         */
        public function json() {
-               $array = wp_array_slice_assoc( (array) $this, array( 'id', 'description', 'priority', 'panel', 'type' ) );
+               $array = wp_array_slice_assoc( (array) $this, array( 'id', 'description', 'priority', 'panel', 'type', 'description_hidden' ) );
                $array['title'] = html_entity_decode( $this->title, ENT_QUOTES, get_bloginfo( 'charset' ) );
                $array['content'] = $this->get_content();
                $array['active'] = $this->active();
@@ -306,7 +318,7 @@ class WP_Customize_Section {
        /**
         * Render the section UI in a subclass.
         *
-        * Sections are now rendered in JS by default, see {@see WP_Customize_Section::print_template()}.
+        * Sections are now rendered in JS by default, see WP_Customize_Section::print_template().
         *
         * @since 3.4.0
         */
@@ -324,11 +336,11 @@ class WP_Customize_Section {
         * @see WP_Customize_Manager::render_template()
         */
        public function print_template() {
-        ?>
+               ?>
                <script type="text/html" id="tmpl-customize-section-<?php echo $this->type; ?>">
                        <?php $this->render_template(); ?>
                </script>
-        <?php
+               <?php
        }
 
        /**
@@ -347,10 +359,10 @@ class WP_Customize_Section {
                <li id="accordion-section-{{ data.id }}" class="accordion-section control-section control-section-{{ data.type }}">
                        <h3 class="accordion-section-title" tabindex="0">
                                {{ data.title }}
-                               <span class="screen-reader-text"><?php _e( 'Press return or enter to open' ); ?></span>
+                               <span class="screen-reader-text"><?php _e( 'Press return or enter to open this section' ); ?></span>
                        </h3>
                        <ul class="accordion-section-content">
-                               <li class="customize-section-description-container">
+                               <li class="customize-section-description-container section-meta <# if ( data.description_hidden ) { #>customize-info<# } #>">
                                        <div class="customize-section-title">
                                                <button class="customize-section-back" tabindex="-1">
                                                        <span class="screen-reader-text"><?php _e( 'Back' ); ?></span>
@@ -361,8 +373,15 @@ class WP_Customize_Section {
                                                        </span>
                                                        {{ data.title }}
                                                </h3>
+                                               <# if ( data.description && data.description_hidden ) { #>
+                                                       <button type="button" class="customize-help-toggle dashicons dashicons-editor-help" aria-expanded="false"><span class="screen-reader-text"><?php _e( 'Help' ); ?></span></button>
+                                                       <div class="description customize-section-description">
+                                                               {{{ data.description }}}
+                                                       </div>
+                                               <# } #>
                                        </div>
-                                       <# if ( data.description ) { #>
+
+                                       <# if ( data.description && ! data.description_hidden ) { #>
                                                <div class="description customize-section-description">
                                                        {{{ data.description }}}
                                                </div>
@@ -374,204 +393,14 @@ class WP_Customize_Section {
        }
 }
 
-/**
- * Customize Themes Section class.
- *
- * A UI container for theme controls, which behaves like a backwards Panel.
- *
- * @since 4.2.0
- *
- * @see WP_Customize_Section
- */
-class WP_Customize_Themes_Section extends WP_Customize_Section {
-
-       /**
-        * Customize section type.
-        *
-        * @since 4.2.0
-        * @access public
-        * @var string
-        */
-       public $type = 'themes';
-
-       /**
-        * Render the themes section, which behaves like a panel.
-        *
-        * @since 4.2.0
-        * @access protected
-        */
-       protected function render() {
-               $classes = 'accordion-section control-section control-section-' . $this->type;
-               ?>
-               <li id="accordion-section-<?php echo esc_attr( $this->id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
-                       <h3 class="accordion-section-title">
-                               <?php
-                               if ( $this->manager->is_theme_active() ) {
-                                       echo '<span class="customize-action">' . __( 'Active theme' ) . '</span> ' . $this->title;
-                               } else {
-                                       echo '<span class="customize-action">' . __( 'Previewing theme' ) . '</span> ' . $this->title;
-                               }
-                               ?>
-
-                               <button type="button" class="button change-theme" tabindex="0"><?php _ex( 'Change', 'theme' ); ?></button>
-                       </h3>
-                       <div class="customize-themes-panel control-panel-content themes-php">
-                               <h3 class="accordion-section-title customize-section-title">
-                                       <span class="customize-action"><?php _e( 'Customizing' ); ?></span>
-                                       <?php _e( 'Themes' ); ?>
-                                       <span class="title-count theme-count"><?php echo count( $this->controls ) + 1 /* Active theme */; ?></span>
-                               </h3>
-                               <h3 class="accordion-section-title customize-section-title">
-                                       <?php
-                                       if ( $this->manager->is_theme_active() ) {
-                                               echo '<span class="customize-action">' . __( 'Active theme' ) . '</span> ' . $this->title;
-                                       } else {
-                                               echo '<span class="customize-action">' . __( 'Previewing theme' ) . '</span> ' . $this->title;
-                                       }
-                                       ?>
-                                       <button type="button" class="button customize-theme"><?php _e( 'Customize' ); ?></button>
-                               </h3>
-
-                               <div class="theme-overlay" tabindex="0" role="dialog" aria-label="<?php esc_attr_e( 'Theme Details' ); ?>"></div>
-
-                               <div id="customize-container"></div>
-                               <?php if ( count( $this->controls ) > 4 ) : ?>
-                                       <p><label for="themes-filter">
-                                               <span class="screen-reader-text"><?php _e( 'Search installed themes...' ); ?></span>
-                                               <input type="text" id="themes-filter" placeholder="<?php esc_attr_e( 'Search installed themes...' ); ?>" />
-                                       </label></p>
-                               <?php endif; ?>
-                               <div class="theme-browser rendered">
-                                       <ul class="themes accordion-section-content">
-                                       </ul>
-                               </div>
-                       </div>
-               </li>
-<?php }
-}
-
-/**
- * Customizer section representing widget area (sidebar).
- *
- * @since 4.1.0
- *
- * @see WP_Customize_Section
- */
-class WP_Customize_Sidebar_Section extends WP_Customize_Section {
-
-       /**
-        * Type of this section.
-        *
-        * @since 4.1.0
-        * @access public
-        * @var string
-        */
-       public $type = 'sidebar';
-
-       /**
-        * Unique identifier.
-        *
-        * @since 4.1.0
-        * @access public
-        * @var string
-        */
-       public $sidebar_id;
-
-       /**
-        * 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() {
-               $json = parent::json();
-               $json['sidebarId'] = $this->sidebar_id;
-               return $json;
-       }
-
-       /**
-        * Whether the current sidebar is rendered on the page.
-        *
-        * @since 4.1.0
-        * @access public
-        *
-        * @return bool Whether sidebar is rendered.
-        */
-       public function active_callback() {
-               return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
-       }
-}
-
-/**
- * Customize Menu Section Class
- *
- * Custom section only needed in JS.
- *
- * @since 4.3.0
- *
- * @see WP_Customize_Section
- */
-class WP_Customize_Nav_Menu_Section extends WP_Customize_Section {
+/** WP_Customize_Themes_Section class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-themes-section.php' );
 
-       /**
-        * Control type.
-        *
-        * @since 4.3.0
-        * @access public
-        * @var string
-        */
-       public $type = 'nav_menu';
+/** WP_Customize_Sidebar_Section class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-sidebar-section.php' );
 
-       /**
-        * Get section parameters for JS.
-        *
-        * @since 4.3.0
-        * @access public
-        * @return array Exported parameters.
-        */
-       public function json() {
-               $exported = parent::json();
-               $exported['menu_id'] = intval( preg_replace( '/^nav_menu\[(\d+)\]/', '$1', $this->id ) );
-
-               return $exported;
-       }
-}
-
-/**
- * Customize Menu Section Class
- *
- * Implements the new-menu-ui toggle button instead of a regular section.
- *
- * @since 4.3.0
- *
- * @see WP_Customize_Section
- */
-class WP_Customize_New_Menu_Section extends WP_Customize_Section {
-
-       /**
-        * Control type.
-        *
-        * @since 4.3.0
-        * @access public
-        * @var string
-        */
-       public $type = 'new_menu';
+/** WP_Customize_Nav_Menu_Section class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-section.php' );
 
-       /**
-        * Render the section, and the controls that have been added to it.
-        *
-        * @since 4.3.0
-        * @access protected
-        */
-       protected function render() {
-               ?>
-               <li id="accordion-section-<?php echo esc_attr( $this->id ); ?>" class="accordion-section-new-menu">
-                       <button type="button" class="button-secondary add-new-menu-item add-menu-toggle" aria-expanded="false">
-                               <?php echo esc_html( $this->title ); ?>
-                       </button>
-                       <ul class="new-menu-section-content"></ul>
-               </li>
-               <?php
-       }
-}
+/** WP_Customize_New_Menu_Section class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-section.php' );