vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-10-06 15:47:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve/introduce Customizer JavaScript models for Controls, Sections, and Panels.

Browse Source 
* Introduce models for panels and sections.
* Introduce API to expand and focus a control, section or panel.
* Allow deep-linking to panels, sections, and controls inside of the Customizer.
* Clean up `accordion.js`, removing all Customizer-specific logic.
* Add initial unit tests for `wp.customize.Class` in `customize-base.js`.

https://make.wordpress.org/core/2014/10/27/toward-a-complete-javascript-api-for-the-customizer/ provides an overview of how to use the JavaScript API.

props westonruter, celloexpressions, ryankienstra.
see #28032, #28579, #28580, #28650, #28709, #29758.
fixes #29529.



git-svn-id: https://develop.svn.wordpress.org/trunk@30102 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Dominik Schilling (ocean90)
2014-10-29 22:50:21 +00:00
parent 037e00fb15
commit 90182015e7
12 changed files with 1470 additions and 294 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-includes/class-wp-customize-control.php
+35 -1
View File
@@ -74,6 +74,7 @@ class WP_Customize_Control {
public $input_attrs = array();
/**
* @deprecated It is better to just call the json() method
* @access public
* @var array
*/
@@ -218,9 +219,24 @@ class WP_Customize_Control {
}
$this->json['type'] = $this->type;
$this->json['priority'] = $this->priority;
$this->json['active'] = $this->active();
$this->json['section'] = $this->section;
$this->json['content'] = $this->get_content();
$this->json['label'] = $this->label;
$this->json['description'] = $this->description;
$this->json['active'] = $this->active();
}
/**
* Get the data to export to the client via JSON.
*
* @since 4.1.0
*
* @return array
*/
public function json() {
$this->to_json();
return $this->json;
}
/**
@@ -243,6 +259,21 @@ class WP_Customize_Control {
return true;
}
/**
* Get the control's content for insertion into the Customizer pane.
*
* @since 4.1.0
*
* @return string
*/
public final function get_content() {
ob_start();
$this->maybe_render();
$template = trim( ob_get_contents() );
ob_end_clean();
return $template;
}
/**
* Check capabilities and render the control.
*
@@ -1073,6 +1104,7 @@ class WP_Customize_Header_Image_Control extends WP_Customize_Image_Control {
/**
* Widget Area Customize Control Class
*
* @since 3.9.0
*/
class WP_Widget_Area_Customize_Control extends WP_Customize_Control {
public $type = 'sidebar_widgets';
@@ -1114,6 +1146,8 @@ class WP_Widget_Area_Customize_Control extends WP_Customize_Control {
/**
* Widget Form Customize Control Class
*
* @since 3.9.0
*/
class WP_Widget_Form_Customize_Control extends WP_Customize_Control {
public $type = 'widget_form';
src/wp-includes/class-wp-customize-manager.php
+12 -4
View File
@@ -498,6 +498,8 @@ final class WP_Customize_Manager {
$settings = array(
'values' => array(),
'channel' => wp_unslash( $_POST['customize_messenger_channel'] ),
'activePanels' => array(),
'activeSections' => array(),
'activeControls' => array(),
);
@@ -511,6 +513,12 @@ final class WP_Customize_Manager {
foreach ( $this->settings as $id => $setting ) {
$settings['values'][ $id ] = $setting->js_value();
}
foreach ( $this->panels as $id => $panel ) {
$settings['activePanels'][ $id ] = $panel->active();
}
foreach ( $this->sections as $id => $section ) {
$settings['activeSections'][ $id ] = $section->active();
}
foreach ( $this->controls as $id => $control ) {
$settings['activeControls'][ $id ] = $control->active();
}
@@ -911,11 +919,11 @@ final class WP_Customize_Manager {
if ( ! $section->panel ) {
// Top-level section.
$sections[] = $section;
$sections[ $section->id ] = $section;
} else {
// This section belongs to a panel.
if ( isset( $this->panels [ $section->panel ] ) ) {
$this->panels[ $section->panel ]->sections[] = $section;
$this->panels[ $section->panel ]->sections[ $section->id ] = $section;
}
}
}
@@ -932,8 +940,8 @@ final class WP_Customize_Manager {
continue;
}
usort( $panel->sections, array( $this, '_cmp_priority' ) );
$panels[] = $panel;
uasort( $panel->sections, array( $this, '_cmp_priority' ) );
$panels[ $panel->id ] = $panel;
}
$this->panels = $panels;
src/wp-includes/class-wp-customize-panel.php
+95 -4
View File
@@ -82,6 +82,28 @@ class WP_Customize_Panel {
*/
public $sections;
/**
* @since 4.1.0
* @access public
* @var string
*/
public $type;
/**
* 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 section is active (such as it relates to the URL
* currently being previewed).
*/
public $active_callback = '';
/**
* Constructor.
*
@@ -103,12 +125,69 @@ class WP_Customize_Panel {
$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.
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.
*/
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;
}
/**
* 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();
return $array;
}
/**
* Checks required user capabilities and whether the theme has the
* feature support required by the panel.
@@ -129,6 +208,21 @@ class WP_Customize_Panel {
return true;
}
/**
* Get the panel's content template for insertion into the Customizer pane.
*
* @since 4.1.0
*
* @return string
*/
public final function get_content() {
ob_start();
$this->maybe_render();
$template = trim( ob_get_contents() );
ob_end_clean();
return $template;
}
/**
* Check capabilities and render the panel.
*
@@ -189,7 +283,7 @@ class WP_Customize_Panel {
*/
protected function render_content() {
?>
<li class="accordion-section control-section<?php if ( empty( $this->description ) ) echo ' cannot-expand'; ?>">
<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 */
@@ -203,8 +297,5 @@ class WP_Customize_Panel {
<?php endif; ?>
</li>
<?php
foreach ( $this->sections as $section ) {
$section->maybe_render();
}
}
}
src/wp-includes/class-wp-customize-section.php
+105 -12
View File
@@ -91,6 +91,28 @@ class WP_Customize_Section {
*/
public $controls;
/**
* @since 4.1.0
* @access public
* @var string
*/
public $type;
/**
* 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 section is active (such as it relates to the URL
* currently being previewed).
*/
public $active_callback = '';
/**
* Constructor.
*
@@ -105,18 +127,76 @@ class WP_Customize_Section {
public function __construct( $manager, $id, $args = array() ) {
$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' );
}
$this->controls = array(); // Users cannot customize the $controls array.
return $this;
}
/**
* 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;
}
/**
* 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', 'panel', 'type' ) );
$array['content'] = $this->get_content();
$array['active'] = $this->active();
return $array;
}
/**
* Checks required user capabilities and whether the theme has the
* feature support required by the section.
@@ -126,23 +206,41 @@ class WP_Customize_Section {
* @return bool False if theme doesn't support the section or user doesn't have the capability.
*/
public final function check_capabilities() {
if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) )
if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) ) {
return false;
}
if ( $this->theme_supports && ! call_user_func_array( 'current_theme_supports', (array) $this->theme_supports ) )
if ( $this->theme_supports && ! call_user_func_array( 'current_theme_supports', (array) $this->theme_supports ) ) {
return false;
}
return true;
}
/**
* Get the section's content template for insertion into the Customizer pane.
*
* @since 4.1.0
*
* @return string
*/
public final function get_content() {
ob_start();
$this->maybe_render();
$template = trim( ob_get_contents() );
ob_end_clean();
return $template;
}
/**
* Check capabilities and render the section.
*
* @since 3.4.0
*/
public final function maybe_render() {
if ( ! $this->check_capabilities() )
if ( ! $this->check_capabilities() ) {
return;
}
/**
* Fires before rendering a Customizer section.
@@ -172,9 +270,6 @@ class WP_Customize_Section {
*/
protected function render() {
$classes = 'control-section accordion-section';
if ( $this->panel ) {
$classes .= ' control-subsection';
}
?>
<li id="accordion-section-<?php echo esc_attr( $this->id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
<h3 class="accordion-section-title" tabindex="0">
@@ -183,12 +278,10 @@ class WP_Customize_Section {
</h3>
<ul class="accordion-section-content">
<?php if ( ! empty( $this->description ) ) : ?>
<li><p class="description customize-section-description"><?php echo $this->description; ?></p></li>
<li class="customize-section-description-container">
<p class="description customize-section-description"><?php echo $this->description; ?></p>
</li>
<?php endif; ?>
<?php
foreach ( $this->controls as $control )
$control->maybe_render();
?>
</ul>
</li>
<?php
src/wp-includes/js/customize-base.js
+2 -1
View File
@@ -184,8 +184,9 @@ window.wp = window.wp || {};
to = this.validate( to );
// Bail if the sanitized value is null or unchanged.
if ( null === to || _.isEqual( from, to ) )
if ( null === to || _.isEqual( from, to ) ) {
return this;
}
this._value = to;
this._dirty = true;
src/wp-includes/js/customize-preview.js
+2
View File
@@ -107,6 +107,8 @@
});
preview.send( 'ready', {
activePanels: api.settings.activePanels,
activeSections: api.settings.activeSections,
activeControls: api.settings.activeControls
} );