Changeset 35724 for trunk/src/wp-includes/class-wp-customize-setting.php

Timestamp:

11/21/2015 02:51:57 AM (9 years ago)

Author:

westonruter

Message:

Customize: Ensure that a setting (especially a multidimensional one) can still be previewed when the post value to preview is set after preview() is invoked.

• Introduce customize_post_value_set_{$setting_id} and customize_post_value_set actions which are done when WP_Customize_Manager::set_post_value() is called.
• Clear the preview_applied flag for aggregated multidimensional settings when a post value is set. This ensures the new value is used instead of a previously-cached previewed value.
• Move $is_preview property from subclasses to WP_Customize_Setting parent class.
• Deferred preview: Ensure that when preview() short-circuits due to not being applicable that it will be called again later when the post value is set.
• Populate post value for updated-widget with the (unsanitized) JS-value in WP_Customize_Widgets::call_widget_update() so that value will be properly sanitized when accessed in WP_Customize_Manager::post_value().

Includes unit tests with assertions to check the reported issues and validate the fixes.

Fixes defect introduced in [35007].
See #32103.
Fixes #34738.

File:

• trunk/src/wp-includes/class-wp-customize-setting.php (modified) (7 diffs)

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

@@ -83 +83 @@
 
     /**
+     * Whether or not preview() was called.
+     *
+     * @since 4.4.0
+     * @access protected
+     * @var bool
+     */
+    protected $is_previewed = false;
+
+    /**
      * Cache of multidimensional values to improve performance.
      *
@@ -192 +201 @@
 
         if ( ! empty( $this->id_data['keys'] ) ) {
+            // Note the preview-applied flag is cleared at priority 9 to ensure it is cleared before a deferred-preview runs.
+            add_action( "customize_post_value_set_{$this->id}", array( $this, '_clear_aggregated_multidimensional_preview_applied_flag' ), 9 );
             $this->is_multidimensional_aggregated = true;
         }
@@ -246 +257 @@
             $this->_previewed_blog_id = get_current_blog_id();
         }
+
+        // Prevent re-previewing an already-previewed setting.
+        if ( $this->is_previewed ) {
+            return true;
+        }
+
         $id_base = $this->id_data['base'];
         $is_multidimensional = ! empty( $this->id_data['keys'] );
@@ -274 +291 @@
         }
 
+        // If the setting does not need previewing now, defer to when it has a value to preview.
         if ( ! $needs_preview ) {
+            if ( ! has_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) ) ) {
+                add_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) );
+            }
             return false;
         }
@@ -328 +349 @@
                 do_action( "customize_preview_{$this->type}", $this );
         }
+
+        $this->is_previewed = true;
+
         return true;
+    }
+
+    /**
+     * Clear out the previewed-applied flag for a multidimensional-aggregated value whenever its post value is updated.
+     *
+     * This ensures that the new value will get sanitized and used the next time
+     * that <code>WP_Customize_Setting::_multidimensional_preview_filter()</code>
+     * is called for this setting.
+     *
+     * @since 4.4.0
+     * @access private
+     * @see WP_Customize_Manager::set_post_value()
+     * @see WP_Customize_Setting::_multidimensional_preview_filter()
+     */
+    final public function _clear_aggregated_multidimensional_preview_applied_flag() {
+        unset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['preview_applied_instances'][ $this->id ] );
     }
 
@@ -370 +410 @@
      *
      * @since 4.4.0
-     * @access public
+     * @access private
      *
      * @see WP_Customize_Setting::$aggregated_multidimensionals
@@ -376 +416 @@
      * @return mixed New or old value.
      */
-    public function _multidimensional_preview_filter( $original ) {
+    final public function _multidimensional_preview_filter( $original ) {
         if ( ! $this->is_current_blog_previewed() ) {
             return $original;