Changeset 31410

Timestamp:

02/11/2015 06:24:01 AM (12 years ago)

Author:

dd32

Message:

Ensure that WP_Customize_Setting::value() returns default value for setting if not dirty.

There was regression introduced by #28580 where only changed (dirty) settings now are POST'ed to the Customizer preview.

• Allow WP_Customize_Manager::post_value() to accept a second $default argument.
• Introduce WP_Customize_Manager::unsanitized_post_values() for accessing previously-private member variable _post_values.
• Do require_once instead of require for Customizer classes.
• Add unit tests for WP_Customize_Manager and WP_Customize_Setting.

Props westonruter, boonebgorges.
Merges [31329] [31339] [31342] [31360] to the 4.1 branch.
Fixes #30988.

Location:

branches/4.1

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-customize-manager.php (modified) (3 diffs)
• src/wp-includes/class-wp-customize-setting.php (modified) (4 diffs)
• tests/phpunit/tests/customize (copied) (copied from trunk/tests/phpunit/tests/customize )
• tests/phpunit/tests/customize/setting.php (modified) (2 diffs)

branches/4.1/src/wp-includes/class-wp-customize-manager.php

@@ -64 +64 @@
 
         /**
-         * $_POST values for Customize Settings.
-         *
-         * @var array
+         * Unsanitized values for Customize Settings parsed from $_POST['customized'].
+         *
+         * @var array|false
          */
         private $_post_values;
@@ -76 +76 @@
          */
         public function __construct() {
-                require( ABSPATH . WPINC . '/class-wp-customize-setting.php' );
-                require( ABSPATH . WPINC . '/class-wp-customize-panel.php' );
-                require( ABSPATH . WPINC . '/class-wp-customize-section.php' );
-                require( ABSPATH . WPINC . '/class-wp-customize-control.php' );
-                require( ABSPATH . WPINC . '/class-wp-customize-widgets.php' );
+                require_once( ABSPATH . WPINC . '/class-wp-customize-setting.php' );
+                require_once( ABSPATH . WPINC . '/class-wp-customize-panel.php' );
+                require_once( ABSPATH . WPINC . '/class-wp-customize-section.php' );
+                require_once( ABSPATH . WPINC . '/class-wp-customize-control.php' );
+                require_once( ABSPATH . WPINC . '/class-wp-customize-widgets.php' );
 
                 $this->widgets = new WP_Customize_Widgets( $this );
@@ -400 +400 @@
 
         /**
-         * Decode the $_POST['customized'] values for a specific Customize Setting.
-         *
-         * @since 3.4.0
+         * Parse the incoming $_POST['customized'] JSON data and store the unsanitized
+         * settings for subsequent post_value() lookups.
+         *
+         * @since 4.1.1
+         *
+         * @return array
+         */
+        public function unsanitized_post_values() {
+                if ( ! isset( $this->_post_values ) ) {
+                        if ( isset( $_POST['customized'] ) ) {
+                                $this->_post_values = json_decode( wp_unslash( $_POST['customized'] ), true );
+                        }
+                        if ( empty( $this->_post_values ) ) { // if not isset or of JSON error
+                                $this->_post_values = false;
+                        }
+                }
+                if ( empty( $this->_post_values ) ) {
+                        return array();
+                } else {
+                        return $this->_post_values;
+                }
+        }
+
+        /**
+         * Return the sanitized value for a given setting from the request's POST data.
+         *
+         * @since 3.4.0
+         * @since 4.1.1 Introduced 'default' parameter.
          *
          * @param WP_Customize_Setting $setting A WP_Customize_Setting derived object
-         * @return string $post_value Sanitized value
-         */
-        public function post_value( $setting ) {
-                if ( ! isset( $this->_post_values ) ) {
-                        if ( isset( $_POST['customized'] ) )
-                                $this->_post_values = json_decode( wp_unslash( $_POST['customized'] ), true );
-                        else
-                                $this->_post_values = false;
-                }
-
-                if ( isset( $this->_post_values[ $setting->id ] ) )
-                        return $setting->sanitize( $this->_post_values[ $setting->id ] );
+         * @param mixed $default value returned $setting has no post value (added in 4.2.0).
+         * @return string|mixed $post_value Sanitized value or the $default provided
+         */
+        public function post_value( $setting, $default = null ) {
+                $post_values = $this->unsanitized_post_values();
+                if ( array_key_exists( $setting->id, $post_values ) ) {
+                        return $setting->sanitize( $post_values[ $setting->id ] );
+                } else {
+                        return $default;
+                }
         }
 

branches/4.1/src/wp-includes/class-wp-customize-setting.php

@@ -104 +104 @@
         }
 
+        protected $_original_value;
+
         /**
          * Handle previewing the setting.
@@ -110 +112 @@
          */
         public function preview() {
+                if ( ! isset( $this->_original_value ) ) {
+                        $this->_original_value = $this->value();
+                }
+
                 switch( $this->type ) {
                         case 'theme_mod' :
@@ -160 +166 @@
          */
         public function _preview_filter( $original ) {
-                return $this->multidimensional_replace( $original, $this->id_data[ 'keys' ], $this->post_value() );
+                $undefined = new stdClass(); // symbol hack
+                $post_value = $this->manager->post_value( $this, $undefined );
+                if ( $undefined === $post_value ) {
+                        $value = $this->_original_value;
+                } else {
+                        $value = $post_value;
+                }
+
+                return $this->multidimensional_replace( $original, $this->id_data['keys'], $value );
         }
 
@@ -426 +440 @@
                 }
 
-                if ( $create && ! isset( $node[ $last ] ) )
-                        $node[ $last ] = array();
+                if ( $create ) {
+                        if ( ! is_array( $node ) ) {
+                                // account for an array overriding a string or object value
+                                $node = array();
+                        }
+                        if ( ! isset( $node[ $last ] ) ) {
+                                $node[ $last ] = array();
+                        }
+                }
 
                 if ( ! isset( $node[ $last ] ) )

branches/4.1/tests/phpunit/tests/customize/setting.php

@@ -216 +216 @@
                         $this->arrayHasKey( 'bar', $base_value );
                         $this->assertEquals( $base_initial_value['foo'], $base_value['foo'] );
-                        $this->assertEquals( $base_initial_value['bar'], call_user_func( $type_options['getter'], $base_name, $this->undefined )['bar'] );
+
+                        $getter = call_user_func( $type_options['getter'], $base_name, $this->undefined );
+                        $this->assertEquals( $base_initial_value['bar'], $getter['bar'] );
                         $this->assertEquals( $initial_value, $setting->value() );
                         $setting->preview();
@@ -225 +227 @@
                         $this->assertEquals( $this->post_data_overrides[ $name ], $base_value['foo'] );
                         $this->arrayHasKey( 'bar', call_user_func( $type_options['getter'], $base_name, $this->undefined ) );
-                        $this->assertEquals( $base_initial_value['bar'], call_user_func( $type_options['getter'], $base_name, $this->undefined )['bar'] );
+
+                        $getter = call_user_func( $type_options['getter'], $base_name, $this->undefined );
+                        $this->assertEquals( $base_initial_value['bar'], $getter['bar'] );
                 }
         }