Changeset 35305

Timestamp:

10/20/2015 09:18:04 PM (8 years ago)

Author:

westonruter

Message:

Customizer: Allow new option settings to not be saved as autoloaded by passing an autoload arg value of false.

The autoload argument value is passed along to update_option() which has accepted an $autoload parameter since [31628].

Props westonruter, dlh.
See #26394.
Fixes #33499.

Location:

trunk

Files:

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

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

@@ -144 +144 @@
             // Other setting types can opt-in to aggregate multidimensional explicitly.
             $this->aggregate_multidimensional();
+
+            // Allow option settings to indicate whether they should be autoloaded.
+            if ( 'option' === $this->type && isset( $args['autoload'] ) ) {
+                self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] = $args['autoload'];
+            }
         }
     }
@@ -174 +179 @@
      */
     protected function aggregate_multidimensional() {
-        if ( empty( $this->id_data['keys'] ) ) {
-            return;
-        }
-
         $id_base = $this->id_data['base'];
         if ( ! isset( self::$aggregated_multidimensionals[ $this->type ] ) ) {
@@ -189 +190 @@
             );
         }
-        $this->is_multidimensional_aggregated = true;
+
+        if ( ! empty( $this->id_data['keys'] ) ) {
+            $this->is_multidimensional_aggregated = true;
+        }
     }
 
@@ -503 +507 @@
         $id_base = $this->id_data['base'];
         if ( 'option' === $this->type ) {
-            return update_option( $id_base, $value );
+            $autoload = true;
+            if ( isset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] ) ) {
+                $autoload = self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'];
+            }
+            return update_option( $id_base, $value, $autoload );
         } else if ( 'theme_mod' ) {
             set_theme_mod( $id_base, $value );

trunk/tests/phpunit/tests/customize/setting.php

@@ -473 +473 @@
         restore_current_blog();
     }
+
+    /**
+     * @ticket 33499
+     */
+    function test_option_autoloading() {
+        global $wpdb;
+        wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
+
+        $name = 'autoloaded1';
+        $setting = new WP_Customize_Setting( $this->manager, $name, array(
+            'type' => 'option',
+        ) );
+        $value = 'value1';
+        $this->manager->set_post_value( $setting->id, $value );
+        $setting->save();
+        $autoload = $wpdb->get_var( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s", $setting->id ) );
+        $this->assertEquals( 'yes', $autoload );
+        $this->assertEquals( $value, get_option( $name ) );
+
+        $name = 'autoloaded2';
+        $setting = new WP_Customize_Setting( $this->manager, $name, array(
+            'type' => 'option',
+            'autoload' => true,
+        ) );
+        $value = 'value2';
+        $this->manager->set_post_value( $setting->id, $value );
+        $setting->save();
+        $autoload = $wpdb->get_var( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s", $setting->id ) );
+        $this->assertEquals( 'yes', $autoload );
+        $this->assertEquals( $value, get_option( $name ) );
+
+        $name = 'not-autoloaded1';
+        $setting = new WP_Customize_Setting( $this->manager, $name, array(
+            'type' => 'option',
+            'autoload' => false,
+        ) );
+        $value = 'value3';
+        $this->manager->set_post_value( $setting->id, $value );
+        $setting->save();
+        $autoload = $wpdb->get_var( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s", $setting->id ) );
+        $this->assertEquals( 'no', $autoload );
+        $this->assertEquals( $value, get_option( $name ) );
+
+        $id_base = 'multi-not-autoloaded';
+        $setting1 = new WP_Customize_Setting( $this->manager, $id_base . '[foo]', array(
+            'type' => 'option',
+        ) );
+        $setting2 = new WP_Customize_Setting( $this->manager, $id_base . '[bar]', array(
+            'type' => 'option',
+            'autoload' => false,
+        ) );
+        $this->manager->set_post_value( $setting1->id, 'value1' );
+        $this->manager->set_post_value( $setting2->id, 'value2' );
+        $setting1->save();
+        $autoload = $wpdb->get_var( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s", $id_base ) );
+        $this->assertEquals( 'no', $autoload, 'Even though setting1 did not indicate autoload (thus normally true), since another multidimensional option setting of the base did say autoload=false, it should be autoload=no' );
+    }
 }