<?php
/**
- * Customize Section Class.
- *
- * A UI container for controls, managed by the WP_Customize_Manager.
+ * WordPress Customize Section classes
*
* @package WordPress
* @subpackage Customize
* @since 3.4.0
*/
+
+/**
+ * Customize Section class.
+ *
+ * A UI container for controls, managed by the WP_Customize_Manager class.
+ *
+ * @since 3.4.0
+ *
+ * @see WP_Customize_Manager
+ */
class WP_Customize_Section {
/**
* Used when sorting two instances whose priorities are equal.
*
* @since 4.1.0
+ *
+ * @static
* @access protected
* @var int
*/
$this->instance_number = self::$instance_count;
$this->controls = array(); // Users cannot customize the $controls array.
-
- return $this;
}
/**
*
* @return bool Whether the section is active to the current preview.
*/
- public final function active() {
+ final public function active() {
$section = $this;
$active = call_user_func( $this->active_callback, $this );
* @since 4.1.0
* @access public
*
- * @return bool Always true.
+ * @return true Always true.
*/
public function active_callback() {
return true;
* @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', 'panel', 'type' ) );
+ $array = wp_array_slice_assoc( (array) $this, array( 'id', 'description', 'priority', 'panel', 'type' ) );
+ $array['title'] = html_entity_decode( $this->title, ENT_QUOTES, get_bloginfo( 'charset' ) );
$array['content'] = $this->get_content();
$array['active'] = $this->active();
$array['instanceNumber'] = $this->instance_number;
+
+ if ( $this->panel ) {
+ /* translators: ▸ is the unicode right-pointing triangle, and %s is the section title in the Customizer */
+ $array['customizeAction'] = sprintf( __( 'Customizing ▸ %s' ), esc_html( $this->manager->get_panel( $this->panel )->title ) );
+ } else {
+ $array['customizeAction'] = __( 'Customizing' );
+ }
+
return $array;
}
*
* @return bool False if theme doesn't support the section or 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;
}
}
/**
- * Get the section's content template for insertion into the Customizer pane.
+ * Get the section's content for insertion into the Customizer pane.
*
* @since 4.1.0
*
* @return string Contents of the section.
*/
- public final function get_content() {
+ final public function get_content() {
ob_start();
$this->maybe_render();
- $template = trim( ob_get_contents() );
- ob_end_clean();
- return $template;
+ return trim( ob_get_clean() );
}
/**
*
* @since 3.4.0
*/
- public final function maybe_render() {
+ final public function maybe_render() {
if ( ! $this->check_capabilities() ) {
return;
}
}
/**
- * Render the section, and the controls that have been added to it.
+ * Render the section UI in a subclass.
+ *
+ * Sections are now rendered in JS by default, see {@see WP_Customize_Section::print_template()}.
*
* @since 3.4.0
*/
- protected function render() {
- $classes = 'accordion-section control-section control-section-' . $this->type;
+ protected function render() {}
+
+ /**
+ * Render the section's JS template.
+ *
+ * This function is only run for section types that have been registered with
+ * WP_Customize_Manager::register_section_type().
+ *
+ * @since 4.3.0
+ * @access public
+ *
+ * @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
+ }
+
+ /**
+ * An Underscore (JS) template for rendering this section.
+ *
+ * Class variables for this section class are available in the `data` JS object;
+ * export custom variables by overriding WP_Customize_Section::json().
+ *
+ * @since 4.3.0
+ * @access protected
+ *
+ * @see WP_Customize_Section::print_template()
+ */
+ protected function render_template() {
?>
- <li id="accordion-section-<?php echo esc_attr( $this->id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
+ <li id="accordion-section-{{ data.id }}" class="accordion-section control-section control-section-{{ data.type }}">
<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 expand' ); ?></span>
+ {{ data.title }}
+ <span class="screen-reader-text"><?php _e( 'Press return or enter to open' ); ?></span>
</h3>
<ul class="accordion-section-content">
- <?php if ( ! empty( $this->description ) ) : ?>
- <li class="customize-section-description-container">
- <p class="description customize-section-description"><?php echo $this->description; ?></p>
- </li>
- <?php endif; ?>
+ <li class="customize-section-description-container">
+ <div class="customize-section-title">
+ <button class="customize-section-back" tabindex="-1">
+ <span class="screen-reader-text"><?php _e( 'Back' ); ?></span>
+ </button>
+ <h3>
+ <span class="customize-action">
+ {{{ data.customizeAction }}}
+ </span>
+ {{ data.title }}
+ </h3>
+ </div>
+ <# if ( data.description ) { #>
+ <div class="description customize-section-description">
+ {{{ data.description }}}
+ </div>
+ <# } #>
+ </li>
</ul>
</li>
<?php
}
/**
- * Customizer section representing widget area (sidebar).
+ * Customize Themes Section class.
*
- * @package WordPress
- * @subpackage Customize
+ * 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
*
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 {
+
+ /**
+ * Control type.
+ *
+ * @since 4.3.0
+ * @access public
+ * @var string
+ */
+ public $type = 'nav_menu';
+
+ /**
+ * 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';
+
+ /**
+ * 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
+ }
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff