Changeset 31628

Timestamp:

03/05/2015 07:13:00 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce $autoload parameter to update_option().

When creating an option via add_option(), the $autoload param allows you to
tell WP whether the option should be loaded as part of the 'alloptions' cache
during every pageload. update_option(), when used with a non-existent option
calls add_option() internally. The new $autoload param in update_option()
is passed along to add_option() in cases where the option does not yet exist.

The associated unit tests are skipped on multisite due to an issue that causes
WP_INSTALLING to force cache misses. See #31130.

Props codix, nofearinc, MikeHansenMe.
Fixes #26394.

Location:

trunk

Files:

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

trunk/src/wp-includes/option.php

@@ -222 +222 @@
  *
  * @since 1.0.0
- *
- * @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.
+ * @since 4.2.0 The `$autoload` parameter was added.
+ *
+ * @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.
  * @return bool False if value was not updated and true if value was updated.
  */
-function update_option( $option, $value ) {
+function update_option( $option, $value, $autoload = 'yes' ) {
         global $wpdb;
 
@@ -270 +273 @@
 
         /** This filter is documented in wp-includes/option.php */
-        if ( apply_filters( 'default_option_' . $option, false ) === $old_value )
-                return add_option( $option, $value );
+        if ( apply_filters( 'default_option_' . $option, false ) === $old_value ) {
+                return add_option( $option, $value, '', $autoload );
+        }
 
         $serialized_value = maybe_serialize( $value );

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

@@ -150 +150 @@
                 $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' );
+        }
 }