Changeset 38765

Timestamp:

10/09/2016 08:07:16 PM (7 years ago)

Author:

westonruter

Message:

Customize: Ensure customize_validate_{$setting->id} filters apply on input post values for WP_Customize_Setting subclasses that neglect to apply the filter themselves.

Fixes #37638.

Location:

trunk

Files:

• src/wp-includes/class-wp-customize-manager.php (modified) (1 diff)
• tests/phpunit/tests/customize/manager.php (modified) (2 diffs)

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

@@ -1004 +1004 @@
             }
             $validity = $setting->validate( $unsanitized_value );
+            if ( ! is_wp_error( $validity ) ) {
+                /** This filter is documented in wp-includes/class-wp-customize-setting.php */
+                $late_validity = apply_filters( "customize_validate_{$setting->id}", new WP_Error(), $unsanitized_value, $setting );
+                if ( ! empty( $late_validity->errors ) ) {
+                    $validity = $late_validity;
+                }
+            }
             if ( ! is_wp_error( $validity ) ) {
                 $value = $setting->sanitize( $unsanitized_value );

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

@@ -277 +277 @@
         $this->assertEquals( 'invalid_value_in_validate', $error->get_error_code() );
         $this->assertEquals( array( 'source' => 'filter_customize_validate_foo' ), $error->get_error_data() );
+    }
+
+    /**
+     * Test WP_Customize_Manager::validate_setting_values().
+     *
+     * @ticket 37638
+     * @covers WP_Customize_Manager::validate_setting_values()
+     */
+    function test_late_validate_setting_values() {
+        $setting = new Test_Setting_Without_Applying_Validate_Filter( $this->manager, 'required' );
+        $this->manager->add_setting( $setting );
+
+        $this->assertInstanceOf( 'WP_Error', $setting->validate( '' ) );
+        $setting_validities = $this->manager->validate_setting_values( array( $setting->id => '' ) );
+        $this->assertInstanceOf( 'WP_Error', $setting_validities[ $setting->id ] );
+
+        $this->assertTrue( $setting->validate( 'ok' ) );
+        $setting_validities = $this->manager->validate_setting_values( array( $setting->id => 'ok' ) );
+        $this->assertTrue( $setting_validities[ $setting->id ] );
+
+        add_filter( "customize_validate_{$setting->id}", array( $this, 'late_validate_length' ), 10, 3 );
+        $this->assertTrue( $setting->validate( 'bad' ) );
+        $setting_validities = $this->manager->validate_setting_values( array( $setting->id => 'bad' ) );
+        $validity = $setting_validities[ $setting->id ];
+        $this->assertInstanceOf( 'WP_Error', $validity );
+        $this->assertEquals( 'minlength', $validity->get_error_code() );
+    }
+
+    /**
+     * Add a length constraint to a setting.
+     *
+     * Adds minimum-length error code if the length is less than 10.
+     *
+     * @param WP_Error             $validity Validity.
+     * @param mixed                $value    Value.
+     * @param WP_Customize_Setting $setting  Setting.
+     * @return WP_Error Validity.
+     */
+    function late_validate_length( $validity, $value, $setting ) {
+        $this->assertInstanceOf( 'WP_Customize_Setting', $setting );
+        if ( strlen( $value ) < 10 ) {
+            $validity->add( 'minlength', '' );
+        }
+        return $validity;
     }
 
@@ -1031 +1075 @@
     public $custom;
 }
+
+/**
+ * Class Test_Setting_Without_Applying_Validate_Filter.
+ *
+ * @see Tests_WP_Customize_Manager::test_late_validate_setting_values()
+ */
+class Test_Setting_Without_Applying_Validate_Filter extends WP_Customize_Setting {
+
+    /**
+     * Validates an input.
+     *
+     * @param mixed $value Value to validate.
+     * @return true|WP_Error True if the input was validated, otherwise WP_Error.
+     */
+    public function validate( $value ) {
+        if ( empty( $value ) ) {
+            return new WP_Error( 'empty_value', __( 'You must supply a value' ) );
+        }
+        return true;
+    }
+
+}