Changeset 56788

Timestamp:

10/05/2023 04:13:38 PM (17 months ago)

Author:

flixos90

Message:

Options, Meta APIs: Fix minor compatibility issue with update_option() change.

When calling update_option() with value false on a non-existent option, prior to [56681] the function would have returned false and not stored the value in the database, since the given value was the same as the default.

The aforementioned changeset broke that promise with good intention, however this particular change was a backward compatibility break and therefore is resolved here.

Props mukesh27, costdev.
Fixes #22192.

Location:

trunk

Files:

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

trunk/src/wp-includes/option.php

@@ -806 +806 @@
      * See https://core.trac.wordpress.org/ticket/38903 and https://core.trac.wordpress.org/ticket/22192.
      */
-    if ( $raw_old_value !== $default_value && _is_equal_database_value( $raw_old_value, $value ) ) {
+    if (
+        $value === $raw_old_value ||
+        (
+            $raw_old_value !== $default_value &&
+            _is_equal_database_value( $raw_old_value, $value )
+        )
+    ) {
         return false;
     }

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

@@ -640 +640 @@
             '(float) 0.0'        => array( 0.0, 0.0 ),
             'empty array'        => array( array(), array() ),
+            'false'              => array( false, false ),
 
             /*
-             * false and null are not included in these datasets
-             * because false is the default value, which triggers
+             * null is not included in these datasets because
+             * false is the default value, which triggers
              * a call to add_option().
              *
@@ -680 +681 @@
     public function data_stored_as_empty_string() {
         return array(
-            'false'        => array( false ),
             'empty string' => array( '' ),
             'null'         => array( null ),
@@ -706 +706 @@
         );
 
-        $this->assertTrue( update_option( $option, $default_value ), 'update_option() should have returned true.' );
+        /*
+         * For a non existing option with the unfiltered default of false, passing false here wouldn't work.
+         * Because the default is different than false here though, passing false is expected to result in
+         * a database update.
+         */
+        $this->assertTrue( update_option( $option, false ), 'update_option() should have returned true.' );
 
         $actual = $wpdb->get_row(
@@ -717 +722 @@
         $this->assertIsObject( $actual, 'The option was not added to the database.' );
         $this->assertObjectHasProperty( 'option_value', $actual, 'The "option_value" property was not included.' );
-        $this->assertSame( $default_value, $actual->option_value, 'The value was not stored as an empty string.' );
+        $this->assertSame( '', $actual->option_value, 'The new value was not stored in the database.' );
     }