Changeset 35724 for trunk/tests/phpunit/tests/customize/manager.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/tests/phpunit/tests/customize/manager.php (modified) (8 diffs)

trunk/tests/phpunit/tests/customize/manager.php

@@ -33 +33 @@
         parent::setUp();
         require_once( ABSPATH . WPINC . '/class-wp-customize-manager.php' );
-        $GLOBALS['wp_customize'] = new WP_Customize_Manager();
-        $this->manager = $GLOBALS['wp_customize'];
+        $this->manager = $this->instantiate();
         $this->undefined = new stdClass();
     }
@@ -67 +66 @@
         }
 
-        $manager = $this->instantiate();
+        $manager = $this->manager;
         $this->assertTrue( $manager->doing_ajax() );
 
@@ -83 +82 @@
         }
 
-        $manager = $this->instantiate();
+        $manager = $this->manager;
         $this->assertFalse( $manager->doing_ajax() );
     }
@@ -93 +92 @@
      */
     function test_unsanitized_post_values() {
-        $manager = $this->instantiate();
+        $manager = $this->manager;
 
         $customized = array(
@@ -115 +114 @@
         $_POST['customized'] = wp_slash( wp_json_encode( $posted_settings ) );
 
-        $manager = $this->instantiate();
+        $manager = $this->manager;
 
         $manager->add_setting( 'foo', array( 'default' => 'foo_default' ) );
@@ -128 +127 @@
 
     /**
+     * Test WP_Customize_Manager::set_post_value().
+     *
+     * @see WP_Customize_Manager::set_post_value()
+     */
+    function test_set_post_value() {
+        $this->manager->add_setting( 'foo', array(
+            'sanitize_callback' => array( $this, 'sanitize_foo_for_test_set_post_value' ),
+        ) );
+        $setting = $this->manager->get_setting( 'foo' );
+
+        $this->assertEmpty( $this->captured_customize_post_value_set_actions );
+        add_action( 'customize_post_value_set', array( $this, 'capture_customize_post_value_set_actions' ), 10, 3 );
+        add_action( 'customize_post_value_set_foo', array( $this, 'capture_customize_post_value_set_actions' ), 10, 2 );
+        $this->manager->set_post_value( $setting->id, '123abc' );
+        $this->assertCount( 2, $this->captured_customize_post_value_set_actions );
+        $this->assertEquals( 'customize_post_value_set_foo', $this->captured_customize_post_value_set_actions[0]['action'] );
+        $this->assertEquals( 'customize_post_value_set', $this->captured_customize_post_value_set_actions[1]['action'] );
+        $this->assertEquals( array( '123abc', $this->manager ), $this->captured_customize_post_value_set_actions[0]['args'] );
+        $this->assertEquals( array( $setting->id, '123abc', $this->manager ), $this->captured_customize_post_value_set_actions[1]['args'] );
+
+        $unsanitized = $this->manager->unsanitized_post_values();
+        $this->assertArrayHasKey( $setting->id, $unsanitized );
+
+        $this->assertEquals( '123abc', $unsanitized[ $setting->id ] );
+        $this->assertEquals( 123, $setting->post_value() );
+    }
+
+    /**
+     * Sanitize a value for Tests_WP_Customize_Manager::test_set_post_value().
+     *
+     * @see Tests_WP_Customize_Manager::test_set_post_value()
+     *
+     * @param mixed $value Value.
+     * @return int Value.
+     */
+    function sanitize_foo_for_test_set_post_value( $value ) {
+        return intval( $value );
+    }
+
+    /**
+     * Store data coming from customize_post_value_set action calls.
+     *
+     * @see Tests_WP_Customize_Manager::capture_customize_post_value_set_actions()
+     * @var array
+     */
+    protected $captured_customize_post_value_set_actions = array();
+
+    /**
+     * Capture the actions fired when calling WP_Customize_Manager::set_post_value().
+     *
+     * @see Tests_WP_Customize_Manager::test_set_post_value()
+     */
+    function capture_customize_post_value_set_actions() {
+        $action = current_action();
+        $args = func_get_args();
+        $this->captured_customize_post_value_set_actions[] = compact( 'action', 'args' );
+    }
+
+    /**
      * Test the WP_Customize_Manager::add_dynamic_settings() method.
      *
@@ -133 +191 @@
      */
     function test_add_dynamic_settings() {
-        $manager = $this->instantiate();
+        $manager = $this->manager;
         $setting_ids = array( 'foo', 'bar' );
         $manager->add_setting( 'foo', array( 'default' => 'foo_default' ) );
@@ -163 +221 @@
         add_action( 'customize_register', array( $this, 'action_customize_register_for_dynamic_settings' ) );
 
-        $manager = $this->instantiate();
+        $manager = $this->manager;
         $manager->add_setting( 'foo', array( 'default' => 'foo_default' ) );