Changeset 44662

Timestamp:

01/21/2019 04:26:33 AM (6 years ago)

Author:

peterwilsoncc

Message:

Options: Avoid unnecessary DB calls when updating network options.

Adds a maybe_serialize() comparison for the old and new values in update_network_option() to avoid unnecessary database writes when options contain identical objects.

Props bor0.
Fixes #44956.

Location:

trunk

Files:

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

trunk/src/wp-includes/option.php

@@ -1584 +1584 @@
     $value = apply_filters( "pre_update_site_option_{$option}", $value, $old_value, $option, $network_id );
 
-    if ( $value === $old_value ) {
+    /*
+     * If the new and old values are the same, no need to update.
+     *
+     * Unserialized values will be adequate in most cases. If the unserialized
+     * data differs, the (maybe) serialized data is checked to avoid
+     * unnecessary database calls for otherwise identical object instances.
+     *
+     * See https://core.trac.wordpress.org/ticket/44956
+     */
+    if ( $value === $old_value || maybe_serialize( $value ) === maybe_serialize( $old_value ) ) {
         return false;
     }

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

@@ -170 +170 @@
         $this->assertSame( array( 'this_does_not_exist' => true ), $cache );
     }
+
+    /**
+     * Ensure updating network options containing an object do not result in unneeded database calls.
+     *
+     * @ticket 44956
+     */
+    public function test_update_network_option_array_with_object() {
+        $array_w_object = array(
+            'url'       => 'http://src.wordpress-develop.dev/wp-content/uploads/2016/10/cropped-Blurry-Lights.jpg',
+            'meta_data' => (object) array(
+                'attachment_id' => 292,
+                'height'        => 708,
+                'width'         => 1260,
+            ),
+        );
+
+        $array_w_object_2 = array(
+            'url'       => 'http://src.wordpress-develop.dev/wp-content/uploads/2016/10/cropped-Blurry-Lights.jpg',
+            'meta_data' => (object) array(
+                'attachment_id' => 292,
+                'height'        => 708,
+                'width'         => 1260,
+            ),
+        );
+
+        // Add the option, it did not exist before this.
+        add_network_option( null, 'array_w_object', $array_w_object );
+
+        $num_queries_pre_update = get_num_queries();
+
+        // Update the option using the same array with an object for the value.
+        $this->assertFalse( update_network_option( null, 'array_w_object', $array_w_object_2 ) );
+
+        // Check that no new database queries were performed.
+        $this->assertEquals( $num_queries_pre_update, get_num_queries() );
+    }
 }