Changeset 31473

Timestamp:

02/18/2015 07:13:43 PM (10 years ago)

Author:

boonebgorges

Message:

Respect 'default_option_' filters during early sanity checks in add_option() and update_option().

add_option() and update_option() both call get_option() to compare the
value passed to the function with any existing value for the given option name.
When a 'default_option_' filter is in place to change the default value of
an option, add_option() and update_option() ought to check against the
filtered value, rather than a hardcoded false, in order to determine whether
a prior value exists.

Props GregLone, tyxla.
Fixes #31047.

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

@@ -269 +269 @@
         return false;
 
-    if ( false === $old_value )
+    /** This filter is documented in wp-includes/option.php */
+    if ( apply_filters( 'default_option_' . $option, false ) === $old_value )
         return add_option( $option, $value );
 
@@ -371 +372 @@
     $notoptions = wp_cache_get( 'notoptions', 'options' );
     if ( !is_array( $notoptions ) || !isset( $notoptions[$option] ) )
-        if ( false !== get_option( $option ) )
+        /** This filter is documented in wp-includes/option.php */
+        if ( apply_filters( 'default_option_' . $option, false ) !== get_option( $option ) )
             return false;
 

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

@@ -58 +58 @@
         $this->assertTrue( delete_option( 'doesnotexist' ) );
         $this->assertFalse( get_option( 'doesnotexist' ) );
+    }
+
+    /**
+     * @ticket 31047
+     */
+    public function test_add_option_should_respect_default_option_filter() {
+        add_filter( 'default_option_doesnotexist', array( $this, '__return_foo' ) );
+        $added = add_option( 'doesnotexist', 'bar' );
+        remove_filter( 'default_option_doesnotexist', array( $this, '__return_foo' ) );
+
+        $this->assertTrue( $added );
+        $this->assertSame( 'bar', get_option( 'doesnotexist' ) );
+    }
+
+    /**
+     * @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' ) );
     }