From 94791cd8f2c3b739eee03a1fed3120169d10d92f Mon Sep 17 00:00:00 2001 From: Boone Gorges Date: Wed, 18 Feb 2015 19:13:43 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@31473 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/option.php | 6 ++++-- tests/phpunit/tests/option/option.php | 24 ++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/src/wp-includes/option.php b/src/wp-includes/option.php index 1916b7e1fa..566c896331 100644 --- a/src/wp-includes/option.php +++ b/src/wp-includes/option.php @@ -268,7 +268,8 @@ function update_option( $option, $value ) { if ( $value === $old_value ) 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 ); $serialized_value = maybe_serialize( $value ); @@ -370,7 +371,8 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) // Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query $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; $serialized_value = maybe_serialize( $value ); diff --git a/tests/phpunit/tests/option/option.php b/tests/phpunit/tests/option/option.php index f31cdf45f1..d2c8473f26 100644 --- a/tests/phpunit/tests/option/option.php +++ b/tests/phpunit/tests/option/option.php @@ -59,6 +59,30 @@ class Tests_Option_Option extends WP_UnitTestCase { $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' ) ); + } + function test_serialized_data() { $key = rand_str(); $value = array( 'foo' => true, 'bar' => true );