Changeset 31640

Timestamp:

03/06/2015 01:56:44 PM (10 years ago)

Author:

boonebgorges

Message:

Allow $autoload setting to be changed for existing options using update_option().

[31628] made it possible to pass an $autoload param to update_option() that
applies when the option does not yet exist in the database. The current
changeset introduces parity for existing options: the $autoload setting
for existing options can be changed via the $autoload parameter. For internal
simplicity, $autoload is ignored for existing options when $value is not
also changed.

This changeset also moves update_option() tests into their own class.

Props dd32.
Fixes #26394.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (3 diffs)
• tests/phpunit/tests/option/option.php (modified) (2 diffs)
• tests/phpunit/tests/option/updateOption.php (added)

trunk/src/wp-includes/option.php

@@ -226 +226 @@
  * @param string      $option   Option name. Expected to not be SQL-escaped.
  * @param mixed       $value    Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
- * @param string|bool $autoload Optional. Whether to load the option when WordPress starts up. Accepts 'yes' or true to
- *                              enable, 'no' or false to disable. Default is enabled.
+ * @param string|bool $autoload Optional. Whether to load the option when WordPress starts up. For existing options,
+ *                              `$autoload` can only be updated using `update_option()` if `$value` is also changed.
+ *                              Accepts 'yes' or true to enable, 'no' or false to disable. For non-existent options,
+ *                              the default value is 'yes'.
  * @return bool False if value was not updated and true if value was updated.
  */
-function update_option( $option, $value, $autoload = 'yes' ) {
+function update_option( $option, $value, $autoload = null ) {
     global $wpdb;
 
@@ -274 +276 @@
     /** This filter is documented in wp-includes/option.php */
     if ( apply_filters( 'default_option_' . $option, false ) === $old_value ) {
+        // Default setting for new options is 'yes'.
+        if ( null === $autoload ) {
+            $autoload = 'yes';
+        }
+
         return add_option( $option, $value, '', $autoload );
     }
@@ -290 +297 @@
     do_action( 'update_option', $option, $old_value, $value );
 
-    $result = $wpdb->update( $wpdb->options, array( 'option_value' => $serialized_value ), array( 'option_name' => $option ) );
+    $update_args = array(
+        'option_value' => $serialized_value,
+    );
+
+    if ( null !== $autoload ) {
+        $update_args['autoload'] = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes';
+    }
+
+    $result = $wpdb->update( $wpdb->options, $update_args, array( 'option_name' => $option ) );
     if ( ! $result )
         return false;

trunk/tests/phpunit/tests/option/option.php

@@ -72 +72 @@
     }
 
-    /**
-     * @ticket 31047
-     */
-    public function test_update_option_should_respect_default_option_filter_when_option_does_not_yet_exist_in_database() {
-        add_filter( 'default_option_doesnotexist', array( $this, '__return_foo' ) );
-        $added = update_option( 'doesnotexist', 'bar' );
-        remove_filter( 'default_option_doesnotexist', array( $this, '__return_foo' ) );
-
-        $this->assertTrue( $added );
-        $this->assertSame( 'bar', get_option( 'doesnotexist' ) );
-    }
-
     function test_serialized_data() {
         $key = rand_str();
@@ -150 +138 @@
         $this->assertEquals( $expected, $actual->autoload );
     }
-
-    /**
-     * @ticket 26394
-     */
-    public function test_update_option_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_missing() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
-        global $wpdb;
-        wp_cache_flush();
-        update_option( 'test_update_option_default', 'value' );
-        wp_cache_flush();
-
-        // Populate the alloptions cache, which includes autoload=yes options.
-        wp_load_alloptions();
-
-        $before = $wpdb->num_queries;
-        $value = get_option( 'test_update_option_default' );
-        $after = $wpdb->num_queries;
-
-        $this->assertEquals( $before, $after );
-        $this->assertEquals( $value, 'value' );
-    }
-
-    /**
-     * @ticket 26394
-     */
-    public function test_update_option_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_yes() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
-        global $wpdb;
-        wp_cache_flush();
-        update_option( 'test_update_option_default', 'value', 'yes' );
-        wp_cache_flush();
-
-        // Populate the alloptions cache, which includes autoload=yes options.
-        wp_load_alloptions();
-
-        $before = $wpdb->num_queries;
-        $value = get_option( 'test_update_option_default' );
-        $after = $wpdb->num_queries;
-
-        $this->assertEquals( $before, $after );
-        $this->assertEquals( $value, 'value' );
-    }
-
-    /**
-     * @ticket 26394
-     */
-    public function test_update_option_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_no() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
-        global $wpdb;
-        wp_cache_flush();
-        update_option( 'test_update_option_default', 'value', 'no' );
-        wp_cache_flush();
-
-        // Populate the alloptions cache, which does not include autoload=no options.
-        wp_load_alloptions();
-
-        $before = $wpdb->num_queries;
-        $value = get_option( 'test_update_option_default' );
-        $after = $wpdb->num_queries;
-
-        // Database has been hit.
-        $this->assertEquals( $before + 1, $after );
-        $this->assertEquals( $value, 'value' );
-    }
-
-    /**
-     * @ticket 26394
-     */
-    public function test_update_option_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_false() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
-        global $wpdb;
-        wp_cache_flush();
-        update_option( 'test_update_option_default', 'value', false );
-        wp_cache_flush();
-
-        // Populate the alloptions cache, which does not include autoload=no options.
-        wp_load_alloptions();
-
-        $before = $wpdb->num_queries;
-        $value = get_option( 'test_update_option_default' );
-        $after = $wpdb->num_queries;
-
-        // Database has been hit.
-        $this->assertEquals( $before + 1, $after );
-        $this->assertEquals( $value, 'value' );
-    }
 }