Changeset 56681 for trunk/tests/phpunit/tests/option/option.php

Timestamp:

09/25/2023 04:23:52 PM (19 months ago)

Author:

flixos90

Message:

Options, Meta APIs: Improve logic to avoid unnecessary database writes in update_option().

Prior to this change, a strict comparison between the old and new database value could lead to a false negative, since database values are generally stored as strings. For example, passing an integer to update_option() would almost always result in an update given any existing database value for that option would be that number cast to a string.

This changeset adjusts the logic to perform an intentional "loose-y" comparison by casting the values to strings. Extensive coverage previously added in [56648] provides additional confidence that this does not introduce any backward compatibility issues.

Props mukesh27, costdev, spacedmonkey, joemcgill, flixos90, nacin, atimmer, duck_, boonebgorges.
Fixes #22192.

File:

• trunk/tests/phpunit/tests/option/option.php (modified) (1 diff)

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

@@ -525 +525 @@
         );
     }
+
+    /**
+     * Tests that update_option() stores an option that uses
+     * an unfiltered default value of (bool) false.
+     *
+     * @ticket 22192
+     *
+     * @covers ::update_option
+     */
+    public function test_update_option_should_store_option_with_default_value_false() {
+        global $wpdb;
+
+        $option = 'update_option_default_false';
+        update_option( $option, false );
+
+        $actual = $wpdb->query(
+            $wpdb->prepare(
+                "SELECT option_name FROM $wpdb->options WHERE option_name = %s LIMIT 1",
+                $option
+            )
+        );
+
+        $this->assertSame( 1, $actual );
+    }
+
+    /**
+     * Tests that update_option() stores an option that uses
+     * a filtered default value.
+     *
+     * @ticket 22192
+     *
+     * @covers ::update_option
+     */
+    public function test_update_option_should_store_option_with_filtered_default_value() {
+        global $wpdb;
+
+        $option        = 'update_option_custom_default';
+        $default_value = 'default-value';
+
+        add_filter(
+            "default_option_{$option}",
+            static function () use ( $default_value ) {
+                return $default_value;
+            }
+        );
+
+        update_option( $option, $default_value );
+
+        $actual = $wpdb->query(
+            $wpdb->prepare(
+                "SELECT option_name FROM $wpdb->options WHERE option_name = %s LIMIT 1",
+                $option
+            )
+        );
+
+        $this->assertSame( 1, $actual );
+    }
 }